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

时间: 2018-01-09阅读: 61309标签: api

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


1.MinDoc

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


主要功能

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


2.eoLinker

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小时 专业客户成功部门一对一支持。
网址:https://www.eolinker.com/#/


3.apizza

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

主要功能

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


4.RAML

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


主要功能

  1. 支持 examples
  2. 支持 schema 校验
  3. 支持工具测试
网址:https://raml.org/


5.其他工具

1.Swagger:

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

网址:https://swagger.io/ 

2.Showdoc:

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

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

3.apidoc:

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

网址:http://apidocjs.com/

4.RAP:

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

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

5.APIjsON:

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

网址:http://jsonapi.org/


站长推荐

1.云服务推荐: 国内主流云服务商,各类云产品的最新活动,优惠券领取。地址:阿里云腾讯云华为云

2.广告联盟: 整理了目前主流的广告联盟平台,如果你有流量,可以作为参考选择适合你的平台点击进入

链接: http://www.fly63.com/article/detial/342

关闭

RESTful API风格

首先要说,不管你的API属于哪种风格,只要能够满足工作需要,就足够了。API格式并不存在绝对的标准,只存在不同的设计风格。API设计包含两部分:请求和响应。

Node.js中Streams

NodeJs流以难以使用而闻名,甚至更难理解。 好吧,我给你带来了好消息 - 现在已经不是这样了。多年来,开发人员创建了许多软件包,其唯一目的是为了更容易的使用流。 但是,在本文中,我将重点介绍NodJs 原生的流API。

用Node.js创建安全的 GraphQL API

本文的目标是提供关于如何创建安全的 Node.js GraphQL API 的快速指南。使用 GraphQL API 的目的是什么?什么是GraphQL API?什么是GraphQL查询?GraphQL的好处是什么?GraphQL是否优于REST?为什么我们使用Node.js?

如何更好的设计 RESTful API

当您的数据模型已开始稳定,您可以为您的网络应用程序创建公共API。 你意识到,很难对你的API进行重大更改,一旦它发布,并希望尽可能得到尽可能多的前面。 现在,互联网对API设计的意见有很多。

前后端分离,如何防止api接口被恶意调用或攻击

无论网站,还是App目前基本都是基于api接口模式的开发,那么api的安全就尤为重要了。目前攻击最常见的就是“短信轰炸机”,由于短信接口验证是App,网站检验用户手机号最真实的途径,使用短信验证码在提供便利的同时,也成了呗恶意攻击的对象,那么如何才能防止被恶意调用呢?

前端 api 请求缓存方案

在开发 web 应用程序时,性能都是必不可少的话题。对于webpack打包的单页面应用程序而言,我们可以采用很多方式来对性能进行优化,比方说 tree-shaking、模块懒加载、利用 extrens 网络cdn 加速这些常规的优化

vue之按钮权限及优雅请求API

系统开发中按钮级权限控制也是非常重要的功能之一,可以严格控制不同角色用户所拥有的功能权限。首先可以通过vue的自定义指令来控制按钮(div,link也阔以)等的显示与否以及是否禁用状态。

Vue 3.0 的 Composition API 尝鲜

虽然 Vue 3.0 尚未发布,但是其处于 RFC 阶段的 Composition API 已经可以通过插件 @vue/composition-api 进行体验了。接下来的内容我将以构建一个 TODO LIST 应用来体验 Composition API 的用法。

Vue3.0 Function API

Vue 3.0 的发布引起了轩然大波,让我们解读下它的 function api RFC 详细了解一下 Vue 团队是怎么想的吧!首先官方回答了几个最受关注的问题

Vue3 Composition API 如何替换Vue Mixins

想在你的Vue组件之间共享代码?如果你熟悉 Vue 2 则可能知道使用 mixin ,但是新的 Composition API 提供了更好的解决方案。在本文中,我们将研究mixins的缺点,并了解Composition API如何克服它们

点击更多...

内容以共享、参考、研究为目的,不存在任何商业目的。其版权属原作者所有,如有侵权或违规,请与小编联系!情况属实本人将予以删除!

文章投稿关于web前端网站点搜索站长推荐网站地图站长QQ:522607023

小程序专栏: 土味情话心理测试脑筋急转弯幽默笑话段子句子语录成语大全运营推广