出发点

目前 API 通过 GitLab 管理,不同 API 开发团队放文档的地址不同,文档格式也不相同,造成管理和阅读的不便。
MarkDown 文档编写需要固定的格式,占用开发的一部分时间。
方便测试的同学进行测试。

功能介绍

主页:

展示 API 的分类与各分类中的具体的 API。
支持模糊搜索。(输入部分 API 链接自动补全进行提示)。

新增:

添加新的 API。

参数的输入由链接自动生成或者填入 json 格式的参数。
提交之前会根据输入的参数返回请求结果,便于判断录入 API 的正确性。

关注:

便于快速查看 API。

在线测试:

根据用户输入的 url 参数、post 参数与 http 头中的参数返回测试结果。
可修改输入的参数值,便于多次测试。
可以输入多组参数,按照 笛卡尔乘积发送请求。

Markdown:

通过录入的 API 数据,自动生成对应的文档。
给予常用书写格式的提示,可实时查看编写的文档是否有误。

首页:

接口详细信息:

markdown 文档自动生成:

在线测试修改参数:

测试参数与验证参数修改:

在线测试:

email 报告:

自动化定时构件报告详情:


↙↙↙阅读原文可查看相关链接,并与作者交流