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

1、MinDoc

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

MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 php 框架 laravel 开发的一款文档管理系统。

因 php 的部署对普通用户来说太复杂,所以改用 Golang 开发。可以方便用户部署和实用,同时增加Markdown和html两种编辑器。其功能和界面源于 kancloud 。

主要功能

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

2、eoLinker

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

eoLinker拥有业内最强的接口管理功能,无论你是创业团队还是成熟企业,eoLinker将满足你的所有接口管理需求。

在eoLinker上编写或者导入接口文档,邀请团队成员加入项目,接着进行在线的接口测试,并且提供Mock接口给前端进行对接,后续通过完善的文档版本管理以及团队协作功能,不断地对项目进行迭代,提高项目整体的开发效率!

主要功能

  • 快速全面地管理接口文档 :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小时 专业客户成功部门一对一支持。

3、apizza

网址:http://apizza.cc/

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

主要功能

  • api跨域调试量身定制的chrome插件,本地,在线接口,都可以调。
  • 免费的团队协作 免费的团队协作工具,极致的文档编写体验,加快开发效率。
  • 安全的云端存储 安全可靠的云端存储服务,企业安全版支持本地数据中心。
  • 一键分享 与团队共享你的API文档。
  • 支持Postman,Swagger格式 导入Postman/Swagger json 生成文档。
  • 导出离线文档 导出离线文档,部署本地服务器。
  • api Mock 根据文档自动生成返回结果,提供独立URL方便前端测试
  • 支持多种文档 http接口文档,markdown说明文档

4、RAML

网址:https://raml.org/

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

主要功能

  • 支持 examples
  • 支持 schema 校验
  • 支持工具测试

5、其他工具

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字符串,所求即所得。

echarts4离线使用文档_适合写API接口文档的管理工具有哪些?相关推荐

  1. python生成api文档_Django 自动生成api接口文档教程

    最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求 实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...

  2. java 门禁接口_门禁API接口文档.md

    # "闪开"API接口说明 [toc] #### 1:小区注册 使用之前必须先注册小区信息,获得小区的ID * #####接口调用请求说明 http请求方式: POST(请使用ht ...

  3. 智表ZCELL产品V1.4.0开发API接口文档 与 产品功能清单

    为了方便大家使用ZCELL,应网友要求,整理编写了相关文档,现与产品一起同步发布,供大家下载使用,使用过程中如有疑问,请与我QQ联系. 智表(ZCELL)V1.4.0版本  功能清单文档下载地址: 功 ...

  4. 芋道 Spring Boot API 接口文档 Swagger 入门

    点击上方"芋道源码",选择"设为星标" 做积极的人,而不是积极废人! 源码精品专栏 原创 | Java 2020 超神之路,很肝~ 中文详细注释的开源项目 RP ...

  5. 引入swagger2 api接口文档并实现离线文档

    文章目录 前言 目的 导入工具 写一个config类 启动类添加注解 试启动页面 补充并实现文档 特殊点 再次启动页面 导出swagger在线文档为离线文档 忽略SSL证书 前言 本篇文章在于介绍sw ...

  6. java接口文档生成工具_【分享】接口文档生成工具apipost

    一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...

  7. java扫描接口_一种扫描接口并生成可调用API接口文档的方法与流程

    本发明属于JavaWeb开发技术领域,涉及一种API接口文档的生成方法,尤其是一种扫描接口并生成可调用API接口文档的方法. 背景技术: API(Application Programming Int ...

  8. api服务器开发语言,【API编写】介绍一个国内强大的API接口文档写作网站showdoc - 最好的编程语言 - 博客园...

    这几天要写一个接口API文档,经理给我发过来一个,说要弄一个这样的接口文档,我一看,这可麻烦呀,有大纲有详细,我以为要用div+css去一个页面一个页面做呢,这工作量可不小,网站一搜索,竟然有可以直接 ...

  9. android api接口文档,API 接口文档

    API 接口文档 接口类说明 本文档所有接口所涉及的相关类及说明如下: 接口 说明 GsManager SDK 功能接口类,用于调用个数相关功能 GsConfig SDK 配置接口类,用于设置个数相关 ...

最新文章

  1. python 去掉字符串的
  2. 新闻上的文本分类:机器学习大乱斗 王岳王院长 王岳王院长 5 个月前 目标 从头开始实践中文短文本分类,记录一下实验流程与遇到的坑 运用多种机器学习(深度学习 + 传统机器学习)方法比较短文本分类处
  3. html如何自动调整边框大小,html – Chrome与大小调整:显示中的边框:表格
  4. cadence 旋转快捷键_cadence原理图快捷键
  5. LeetCode 1090. 受标签影响的最大值(优先队列)
  6. c++十进制转二进制_二进制与十进制相互转换的原理
  7. dudu注意:这个可能是bug吧?
  8. Writing an ALSA Driver(二)
  9. 17. 维基百科的高性能架构设计分析
  10. Spring自定义属性转换器
  11. diy的电流电压表,高频率采集,上位机同步显示
  12. java从JDK里提取全球数据,包含国家(名称、二字代码、三字代码)、币种(名称和代码)、和语言种类的数据
  13. Ubuntu14.04安装微软雅黑字体
  14. PDF转图片的工具汇总
  15. java随便打数求质数_java随便输入一个数判断是不是质数
  16. ocr文字识别软件安卓
  17. 高新技术企业认定条件及流程
  18. 计算机设备内存,外部设备访问计算机内存的方法与流程
  19. python基于PHP旅游网站的设计与开发
  20. 【反编译系列】反编译so文件(IDA_Pro)

热门文章

  1. Linux图形界面与命令行模式切换
  2. CentOS 6.3安装Nginx开启目录浏览、下载功能
  3. 如何修改webbrowser里的JS函数
  4. C#中多线程和定时器是不是有冲突?
  5. 解决查询时报的cannot be cast to com.credithc.enjoy.manager.OrderResp错误
  6. MySQL中的自适应哈希索引
  7. c语言中包含math.h的时用gcc编译要加-lm参数
  8. php调用C代码的方法详解和zend_parse_parameters函数详解
  9. 微信小程序里页面滚动到底部
  10. oracle 11g 清除 trc后缀文件,请教一个跟踪文件的问题。11g 很多trc文件。。