Rust开发的一款接口设计工具Panda api

Panda api是一款接口设计工具,它可以生成文档、提供接口模拟服务(在你没写任何代码以前)、自动测试后端接口,有效提高项目的开发效率和质量。前端

为何要用Panda Api?

提高开发效率 和 开发质量:git

Panda Api 可以在开发过程当中隔离先后端,让前端为所欲为的掌控接口的请求和返回,而不须要后端开发人员介入。开发环境是影响研发效能最大的一个因素之一,不稳定的上游接口环境会让一个很是简单的需求轻松消耗掉数天的时间。当后端的接口还未开发完成,或者接口突然由于后端某个开发中的功能忽然不能工做时,Panda api能够快速提供接口。github

Panda Api能够提供一个很是高效的前端开发环境和后端测试环境,什么是一个好的开发环境呢?web

一、稳定json

好的开发环境应该是稳定可用的,不该该在开发过程当中受到其余开发人员影响,服务频繁挂掉或者频繁改变,先后端开发的团队成员就深有体会,两边相互影响,而后又致使相互等待,很是影响开发状态和效率。然而不少团队一直是在以这样低效的方式在推动。后端

二、快速验证api

修改代码可以在尽量短的时间内获得验证也是一个基本诉求,这也是为何大部分前端构建都会关注 Hot reload 和更高级的HMR 。有些场景下一次简单前端的修改就要通过长时间等待等待后端开发完成,例如依赖上游修改接口的返回内容,须要修改后端的程序而后从新部署,须要走一遍完整的发布流程来测试某个修改调整,这种改一行等几十分钟的开发方式对效率的拖累是极其恐怖的。websocket

三、一致性前端构建

不少项目,由于参与人员少,以为不须要写什么文档,直接就讨论后开始开发。开发到后面就会发现,你们的共识是不一致的,进一步引起争论和项目的从新调整,若是中途换人或者半年之后再来维护这个项目,就很容易变成一个可怕的泥潭,全部人都不肯意去碰。缘由就是一开始咱们就没有造成文档。传统的接口文档确实很费时间,Panda api把文档即服务作好,写文档变成了一个更高效的开发方式。socket

开发者对于当前的需求应该是有确切认知的,而不是一直不停的怀疑本身的理解到底对不对,相关接口的字段是什么意思。

Panda Api是如何解决好这几个问题

Panda Api的三个核心服务:

  1. 提供先后端的开发的接口文档
  2. 提供前端开发的接口服务
  3. 能够进行后端接口测试

Panda Api 接口文档的工具提供如下功能:

  1. 提供一份能够先后端浏览的接口文档
  2. 使用json或json5语法来写文档,操做成本、学习成本很是低
  3. 接口文档也能够像代码同样进行版本控制,先后端都有维护的权限。Panda api依赖git等版本管理工具来作
  4. 能够在定义好文档后,当即为前端开发提供接口服务,不用等待后端开发完成。为前端支持各种请求:GET, POST, PUT, DELETE, OPTIONS
  5. 可使用这个工具进行前端测试和后端测试
  6. 能够像Mock同样,自动生成相关测试数据

Todo 还在设计开发的功能

  1. 支持多种开发环境切换,例如开发环境、测试环境、正式环境
  2. 支持websocket方式为前端开发提供测试接口服务;支持用websocket方式做为客户端进行后端服务测试
  3. 其它等你使用后来告诉我

Panda Api 项目地址:

https://github.com/arlicle/panda-api

相关文章
相关标签/搜索