乐趣区

关于云计算:自动生成接口文档的三种方式

开始

做开发常常会碰到这样的状况,后期写了接口文档,后端把需要改完没工夫更新接口文档,想想就感觉解体了。那么有没有办法能主动生成接口文档来进步前后端的开发效率呢?

自定义动静生成接口文档,手动部署

在对外裸露的接口上增加一套自定义注解。注解可指定接口名称,申请 url,申请形式,申请参数,申请参数类型,返回参数,返回参数类型等信息。通过解析 controller 类上注解和办法上的注解,生成获取所有对外裸露办法的定义的接口,而后通过 web 页面出现所有接口定义。

项目组所有人应用 Swagger,统一标准

我的项目集成 Swagger 插件,增加 Swagger 依赖,前端人员拜访 Swagger 生成的接口文档,查看和应用接口。

应用 Eolinker,依据需要导出不同格局接口文档

后端开发间接将我的项目导入到 Eolinker,欠缺需要时会主动生成接口代码,导入和导出均反对多种格局,通用性较高。
应用地址:www.eolinker.com

最初

本文的思考来源于工作。我的项目接口文档本应该就是依据代码同时公布的,在多加一步操作,将生成的接口文档主动部署到服务上,就实现接口文档的自动更新,一劳永逸!

退出移动版