在项目开发过程中,我们需要建立在线接口开发文档,主要用于:
1、项目运维时间越长,接口越多,越不方便管理,在线接口文档可以持续保持一份最新的接口文档;
2、在前后端分离开发过程中,方便前后端开发人员针对接口入参、出参保持一致;
3、方便实施人员针对接口进行测试。
在项目中常用的接口文档为swagger2,他以注解的方式实现了动态获取接口描述。与之配套的,有两个ui管理界面分别是swagger-ui,以及国产的swagger-bootstrap-ui。swagger-bootstrap-ui的风格更加适合个人的管理习惯及喜好,此外还能直接生成md格式的接口文档。swagger-bootstrap-ui的demo网址,针对几种使用场景进行了详细的说明,可以参看。
参考网址:
1)swagger-bootstrap-ui的官网(新版本叫knife4j):https://doc.xiaominfo.com/guide/useful.html
2)swagger-bootstrap-ui的demo网址:https://gitee.com/xiaoym/swagger-bootstrap-ui-demo
3)swagger-bootstrap-ui的源码:https://gitee.com/xiaoym/knife4j