在软件开发过程中,接口调试显得重要而繁琐,现在我们经常用到的又postman、yapi等,这里我个人觉得它们都没有一个很好地文档生成功能,还有一些接口变更和调试的记录,
因此往往开发中接口的变更导致文档落后,线上环境的修改与接口文档不一致,为此我开发了本系统,用于解决这类问题;
这里介绍一些本系统的一些亮点:
在软件开发过程中,接口调试显得重要而繁琐,现在我们经常用到的又postman、yapi等,这里我个人觉得它们都没有一个很好地文档生成功能,还有一些接口变更和调试的记录,
因此往往开发中接口的变更导致文档落后,线上环境的修改与接口文档不一致,为此我开发了本系统,用于解决这类问题;
这里介绍一些本系统的一些亮点:
1、可以在线拉取同步swagger接口
在项目信息配置swagger地址,主要是为了通过swagger对外提供的接口信息(具体怎么配置swagger这里就不做解析)
打开swagger地址,会返回对应的具体swagger地址
注意的是 http://xxx/v2/api-docs,必须能正常范文swagger的接口信息如下
同步完成后,系统就会根据swagger返回json数据解析对应的接口,这样我们在开发过程中,每次修改接口后可以同步swagger接口信息即可;
2、在线调试、请求记录查询
系统自动填充当前用户最后一次 请求参数
记录每次请求情况
返回json格式化,可用于后续生成文档
3、在线文档生成
4、数据库文档生成
到此,系统的主要功能已介绍完毕,当然系统也存在一些bug和优化的地方,也适合二次开发。