API 接口文档管理工具哪家强? 未完,待续...

1 Eolinker (收费/免费版)

客户端: web 端 , 浏览器插件 ,pc 端 (这个我觉得比较好用)

界面如下:

image.png

api 接口管理
api 接口测试
一些通用的环境变量切换
常用的功能都有了
还有
状态码文档
和文档管理
权限管理
你常用的他都提供了

当然我们写文档更多的是为了生成交付产物或提供给用户, 最关注的还是导出功能, 收费版很全, 免费版只能导出html 使用,如果你的客户能接受那就可以.

image.png

pc 端直接可以测试调试本机localhost 接口, 测试后返回的数据还可以直接当做返回示例给前端人员, 提高了工作效率, 是个不错的亮点.

编辑界面

测试界面

价格当然是我们最关心的, 目前免费版只能同时3人使用

image.png

优点: 功能齐全
缺点: 这个名字真是不好记, 免费版容纳人数太少, 一些功能层级太深太乱,不够简洁(他们的产品经理应该反思一下)
总结: 3人以下还是不错的一个选择, 毕竟商用的比开源的好用不少.

2 小幺鸡(docway 目前免费)

原来的小幺鸡现在改名, 也要走商用之路了
功能比较简洁只有常用的接口编写和测试, 测试用的是浏览器插件实现

image.png

导出只有pdf 一种格式

image.png

而且这个导出竟然是先点打印时选择目标为pdf , 好取巧的实现, 其实就是把网页另存为了pdf .

image.png

除了在线版的方式外,你也可以自己下载代码 ,直接布署在本地, 对一些对安全有要求的公司也是不错的解决方式,防止重复造轮子.
地址: https://gitee.com/zhoujingjie/apiManager

3 自己开发

目前我的实现方式的前端vue + 后端springboot 的方式,由于代码太乱就发到git 了

image.png

自己实现的好处是自由度比较高, 同时可以实现各种导出功能 .
比如导出word 功能, 可以参见我写的word 导出的那篇文章.