Java API 接口文档

我要开发同款
老衲法号乱来2022年04月22日
205阅读

作品详情

非公司项目,个人利用周末以及下班时间自主研发项目,源码暂时未公开
背景:公司接口文档使用eolinker维护项目的接口文档,每一个接口都需要手动输入,对于每个项目接口多不胜数,参数多不胜数,接口参数变动,让后端和前端对接过于繁琐,市面上也有免费的swagger,但是swagger页面简陋,使用复杂。于是我研究一下,利用反射写了一套Java API 接口文档
功能:
1. 使用教程,展示使用教程
2. PostMan 模拟接口请求
3.文档管理
(1)全局参数 :项目基地址,请求头配置
(2)离线文档:导出项目的接口文档,支持doc文档,由于公司使用eolinker维护项目接口,于是仿写eolinker的json结构对接,导出的json可以直接导入eolinker
(3)数据库文档:导出项目配置好的数据库设计,只可查看不可修改(该功能用于交付客户数据库设计文档,ps:部分公司没有产品设计)
4.API管理: 所有接口都由服务端映射出来的,不需要手动修改,支持接口模拟请求
主要职责:个人开发项目,包含前端后端,简化了swagger使用,前后端分离,前端单独部署,内网服务安全可靠,当然外网也可以,看个人需要
声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论