ps: 非公司项目,个人利用周末以及下班时间自主研发项目,源码暂时未公开
背景:公司接口文档使用eolinker维护项目的接口文档,每一个接口都需要手动输入,对于每个项目接口多不胜数,参数多不胜数,接口参数变动,让后端和前端对接过于繁琐,市面上也有免费的swagger,但是swagger页面简陋,使用复杂。于是我研究一下,利用反射写了一套Java API 接口文档
功能:
1. 使用教程,展示使用教程
2. PostMan 模拟接口请求
3.文档管理
(1)全局参数 :项目基地址,请求头配置
(2)离线文档:导出项目的接口文档,支持doc文档,由于公司使用eolinker维护项目接口,于是仿写eolinker的json结构对接,导出的json可以直接导入eolinker
(3)数据库文档:导出项目配置好的数据库设计,只可查看不可修改(该功能用于交付客户数据库设计文档,ps:部分公司没有产品设计)
4.API管理: 所有接口都由服务端映射出来的,不需要手动修改,支持接口模拟请求