规范管理提高效率——国内主要api接口文档工具盘点

隔壁汪书 · · 536 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

现在开发越来越流行前后端分离架构,使用ajax交互。这时候api接口文档就变的更有意义了。下面盘点一下目前国内市场上比较优秀的接口文档管理工具。

1、 EoLinker

网址:https://www.eolinker.com/
EoLinker拥有业内最强的接口管理功能,无论你是创业团队还是成熟企业,EoLinker将满足你的所有接口管理需求。
在EoLinker上编写或者导入接口文档,邀请团队成员加入项目,接着进行在线的接口测试,并且提供Mock接口给前端进行对接,后续通过完善的文档版本管理以及团队协作功能,不断地对项目进行迭代,提高项目整体的开发效率!

主要功能

快速全面地管理接口文档:

  1. UI可视化文档
  2. 支持表单、RESTful、Raw等设计规范
  3. 通过注释生成文档
  4. 版本管理
  5. 支持富文本/Markdown
  6. 分组管理
  7. 星标标注。

Mock API实现敏捷开发:

  1. 根据文档自动生成校验数据
  2. 支持请求协议、请求方式校验
  3. 支持简易Mock、高级Mock(Mockjs)
  4. 支持跨域调用。

2、 MinDoc

网址:https://www.iminho.me/
MinDoc的前身是SmartWiki文档系统。SmartWiki 是基于 php 框架 laravel 开发的一款文档管理系统。后期用Golang开发,同时增加Markdown和html两种编辑器。其功能和界面源于 kancloud。

主要功能

项目管理,可以对项目进行编辑更改,成员添加等
文档管理,添加和删除文档,文档历史恢复等
用户管理,添加和禁用用户,个人资料更改等
用户权限管理 , 实现用户角色的变更
项目加密,可以设置项目公开状态,私有项目需要通过Token访问
站点配置,二次开发时可以添加自定义配置项
附件管理,可管理所有项目中上传的文件
项目导出,目前支持导出 PDF 格式项目
系统日志。

3、 apizza

网址:http://apizza.cc/
极客专属的api协作管理工具,可以在线模拟调试,快速生成api文档,导出离线版文档。

主要功能

api跨域调试chrome插件
安全可靠的云端存储服务,企业安全版支持本地数据中心。
与团队共享你的API文档。
支持导入Postman/Swagger json 生成文档。
支持导出离线文档,部署本地服务器。
根据文档自动生成返回结果,提供独立URL方便前端测试
支持多种文档 http接口文档,markdown说明文档

4、 其他工具

1) Swagger

网址:https://swagger.io/
通过固定格式的注释生成文档. 省时省力,不过有点学习成本。

2) Showdoc

网址:https://www.showdoc.cc/
一个非常适合IT团队的在线API文档、技术文档工具。

3) Apidoc

网址:http://apidocjs.com/
可以根据代码注释生成web api文档,web接口的注释维护起来更加方便,不需要额外再维护一份文档。

4) RAP

网址:http://rap.taobao.org/org/index.do
一个可视化接口管理工具 通过分析接口结构,动态生成模拟数据,校验真实接口正确性, 围绕接口定义,通过一系列自动化工具提升我们的协作效率。

5) APIJSON

网址:http://jsonapi.org/
客户端可以定义任何JSON结构去向服务端发起请求,服务端就会返回对应结构的JSON字符串,所求即所得。


有疑问加站长微信联系(非本文作者)

本文来自:简书

感谢作者:隔壁汪书

查看原文:规范管理提高效率——国内主要api接口文档工具盘点

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:701969077

536 次点击  
加入收藏 微博
1 回复  |  直到 2020-12-11 18:08:10
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传