高效API 接口管理

当前的Java Web开发中,都是前后端分离,后端只需写接口即可,通常是restful风格。在接口开发过程中, 面临的挑战有三个:
(1)良好的设计文档。后端需要定义好接口的地址、传参以及响应参数等,需要尽可能的让前端开发人员理解设计的接口含义。
(2)合适的工具对接口进行模拟请求。需要有一个工具能够实时对接口进行请求(比如:http请求,看接口是否正确)
(3)多人协作时,能够共同开发接口。能够共享已有的接口信息。
解决的方式:
(1)postman工具或者插件,用起来比较好用,这里写了一篇设置变量和分环境的文档: http://blog.csdn.net/timchen525/article/details/78091297 可以参考下。
postman缺点 ,就是多人协作是收费的,且不能对参数进行注释。 (个人用合适,多人合作时有缺点)
(2)apizza工具,是一种高度模仿postman的web版的应用。最主要的有点有:免费支持多人协作,而且在写接口时可以在下方对请求参数进行注释,以及对响应数据进行示例和注释。
appiza工具使用说明:
appiza的官方网址: http://apizza.cc
(1)团队协作
1、注册完成之后,创建一个个人项目:

高效API 接口管理_第1张图片
2、点击进入控制台可以找到对应的项目
3、点击协作,可以添加需要合作的人员的邮箱(合作人员的角色可以为开发者和浏览者模式)
高效API 接口管理_第2张图片
4、根据项目的不同版本进行接口的创建
高效API 接口管理_第3张图片
5、另一个账户查看是否有成功添加到"团队合作项目一"中去, 注意: 需要点击“协作”才可以看到团队合作的项目。
高效API 接口管理_第4张图片
6、其他需要了解的功能包括如下:
1)分环境(dev、test等)管理
2)接口请求参数注释和响应参数注释
3)导出接口参数为html文件


你可能感兴趣的:(Java,Web)