适合写api接口文档的管理工具有哪些?

现在越来越流行前后端分离开发,使用ajax交互。所以api接口文档就变的十分有意义了,目前市场有哪些比较优秀的接口文档管理工具呢?

一键导入,点击复制,方便快捷

链接地址:https://easydoc.xyz/

image
image

1.Showdoc:

一个非常适合IT团队的在线API文档、技术文档工具。

image

网址:https://www.showdoc.cc/

2.eoLinker

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

image
image

主要功能

  • 快速全面地管理接口文档 :1.UI可视化文档,2. 支持表单、RESTful、Raw等设计规范,3. 通过注释生成文档,4. 版本管理,5. 支持富文本/Markdown,6. 分组管理,7. 星标标注。
  • 测试接口是否正常运作:1. 支持在线、本地(localhost)测试,2. 支持跨域测试,3. 支持文件测试,4. 强大的参数构造器。
  • Mock API实现敏捷开发:1. 根据文档自动生成校验数据,2. 支持请求协议、请求方式校验,3. 支持简易Mock、高级Mock(MockJS),4. 支持跨域调用。
  • **了解团队成员动向: **1. 团队人员管理,,2. 支持设置人员读写权限,3. 支持成员昵称,4. 支持通过链接邀请成员。
  • 专业版:1. 强大的插件支持,2. 代码生成,3. 测试用例,4. 空间日志,5. 高级权限管理,6. 5天 * 10小时 专业客户成功部门一对一支持。

网址:https://www.eolinker.com/#/

3.MinDoc

MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加Markdown和HTML两种编辑器。其功能和界面源于 kancloud 。

image

[](javascript:;)主要功能

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

网址:https://www.iminho.me/

4.apizza

极客专属的api协作管理工具 免费的团队协作,在线模拟调试,快速生成api文档,导出离线版文档

image

主要功能

  1. api跨域调试量身定制的chrome插件,本地,在线接口,都可以调。

  2. 免费的团队协作 免费的团队协作工具,极致的文档编写体验,加快开发效率。

  3. 安全的云端存储 安全可靠的云端存储服务,企业安全版支持本地数据中心。

  4. 一键分享 与团队共享你的API文档。

  5. 支持Postman,Swagger格式 导入Postman/Swagger Json 生成文档。

  6. 导出离线文档 导出离线文档,部署本地服务器。

  7. api Mock 根据文档自动生成返回结果,提供独立URL方便前端测试

  8. 支持多种文档 http接口文档,markdown说明文档
    [图片上传中...(image.png-150c34-1539666393114-0)]

网址:http://apizza.cc/

5.RAML

用 YAML 文件格式编写,强大的官方支持,官方提供 atom 插件,支持语法智能提示及校验,编写快速简单。

image

主要功能

  1. 支持 examples
  2. 支持 schema 校验
  3. 支持工具测试

网址:https://raml.org/

5.其他工具

1.Swagger:

通过固定格式的注释生成文档. 省时省力,不过有点学习成本。

网址:https://swagger.io/

2.apidoc:

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

网址:http://apidocjs.com/

3.RAP:

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

网址:http://rap.taobao.org/org/index.do

4.APIJSON:

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

网址:http://apijson.org/
项目主页:
https://github.com/TommyLemon/APIJSON

补充

  • Adoc
    https://github.com/yybawang/Adoc

  • ApiPost
    https://doc.apipost.cn/4a77c87f97fb686b

转载自

作者:每一天为明天168
链接:https://www.jianshu.com/p/d7b13670e0eb
来源:
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。

你可能感兴趣的:(适合写api接口文档的管理工具有哪些?)