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

2023-10-27

现在越来越流行前后端分离开发,使用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字符串,所求即所得。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

适合写API接口文档的管理工具有哪些? 的相关文章

  • JFrame Glasspane 也优于 JDialog,但不应该

    我有一个带有 Glasspane 的 JFrame 未装饰 该框架打开一个 JDialog 也未装饰 也有一个 glassPane 并隐藏自身 setVisible false Glasspanes 通过 setGlassPane 设置 对
  • Java 不可变对象 [关闭]

    Closed 这个问题需要多问focused help closed questions 目前不接受答案 我正在学习不变性的概念 据我了解 一旦创建对象 不可变对象就无法更改其值 但我不明白不可变对象的以下用途 They are 自动是线程
  • 如何从代码隐藏文件中的asp.net用户控件注册(调用)jQuery函数?

    如何从代码隐藏文件中的asp net用户控件注册 调用 jQuery函数 您可以使用ClientScriptManager RegisterStartupScript http msdn microsoft com en us librar
  • 变量值的 swap() 函数[重复]

    这个问题在这里已经有答案了 我无法达到下面这个交换函数的预期结果 我希望将值打印为 3 2 function swap x y var t x x y y t console log swap 2 3 任何线索将不胜感激 您的函数正在内部交
  • Java字符串查找和替换的最佳方法?

    我正在寻找 Java 中字符串查找和替换的最佳方法 这是一句话 我的名字叫米兰 人们都知道我叫米兰瓦西奇 我想用 Milan Vasic 替换 Milan 弦 但在我已经有 Milan Vasic 的地方 情况不应该是这样 搜索 替换后的结
  • 获取包中声明的所有 Java 类的名称

    我正在编写一个功能 它将有助于将类放入我的程序的某个包中 另外 我只想要子类某个类的类 我需要这些类才能调用它们的静态方法 有没有一种自动的方法来做到这一点 如果是的话 速度慢吗 如果我不清楚 我想要的是这样的 ArrayList
  • javax.xml.bind.JAXBException: 类 *** 及其任何超类在此上下文中均未知

    我正在尝试通过 REST Web 服务传递对象 以下是我的课程 使用一些示例代码解释了我需要的功能 Rest Web 服务类方法 POST Path find Consumes MediaType APPLICATION FORM URLE
  • iOS 11 getUserMedia 不起作用?

    苹果公司发表声明称getUserMedia将在 iOS 11 上完全正常运行 安装 iOS 11 Beta 版本 5 后 我确实收到一条消息 表明我的网站请求访问我的相机和麦克风 但似乎是这样的 video src window URL c
  • 更新分页。是否可以?

    他们是否存在一些方法来处理更新分页 例如我有 100 行类型 Id private Integer id Column private boolean flag Column private Date last 一开始它们看起来像 id f
  • Angular 8 webpack-bundle-analyzer 寻找错误的polyfill 文件

    无论我做什么 构建项目后我都会收到以下错误 Error parsing bundle asset
  • WordPress 事件按元生效日期排序

    我在获取参数数组以按 Wordpress 中的日期对事件列表进行排序时遇到一些问题 我在 Stack Overflow 和其他地方找到了几个建议的解决方案 但经过大量的试验和错误后 这些解决方案似乎都不起作用 这没什么花哨的 而且应该比这容
  • Electron Auth0Lock“原始文件://不允许”

    尝试让 auth0 与我的电子应用程序一起使用 当我按照默认教程并尝试使用用户名 密码 身份验证进行身份验证时 锁定失败并显示 403 错误 并响应 不允许使用 Origin file 我还在 auth0 仪表板中客户端设置的允许来源 CO
  • 使用js获取选择选项的onclick事件

    我有一个非常令人沮丧的问题 我有这个代码 它过滤掉我的结果并将它们输入到选择框中 var syn
  • 如何将字符串转换为 Javascript 中可执行的代码行?

    我有以下代码 console log I am var x console log Alive 现在我只想使用x执行分配给它的代码字符串 例如 我什至可能不知道 x 的值 但只是想执行它 这可能吗 eval https developer
  • (A == B == C) 比较在 JavaScript 中如何工作?

    我预计以下比较会给出错误 var A B 0 if A B 0 console log true else console log false 但奇怪的是它又回来了false 更奇怪的是 console log A B 1 returns
  • AndroidAnnotations 和 Dagger

    我正在尝试使用 Dagger 注入 Android 带注释的 Activity java lang IllegalArgumentException No inject registered for members com app serv
  • 使用正则表达式匹配阿拉伯文文本

    我试图使用正则表达式仅匹配阿拉伯语文本 但出现异常 这是我的代码 txt matches P Arabic 这是例外情况 线程 main 中的异常 java util regex PatternSyntaxException 索引 9 附近
  • 查看元素的所有 dom 事件

    我有一个 jQuery UI 日期选择器 当您单击日期时 它会清除我的 URL 哈希值 并且不会更改文本框中的日期 我假设某个地方还有其他一些 JavaScript 实用程序 它也正在调用某种委托事件 抛出错误并终止 jquery 处理程序
  • 如何创建具有同等时间元素的 JavaFX 转换?

    我正在尝试 JavaFX 和动画 尤其是PathTransition 我正在创建一个简单的程序 使球 弹跳 而不使用QuadCurveTo班级 到目前为止 这是我的代码 Ellipse ball new Ellipse 375 250 10
  • PHP 中的 Zip 流

    我有一个 PHP 脚本 可以动态创建 zip 文件并强制浏览器下载该 zip 文件 问题是 我可以直接将zip文件写入连接到用户浏览器的输出流 而不是先将其保存为服务器上的真实文件 然后发送文件吗 提前致谢 如果您的 Web 服务器运行的是

随机推荐

  • 三维重建工具——pclpy使用教程

    最近试了试用pclpy这个库进行点云处理 在此对pclpy的使用进行一个总结 更全的pclpy教程 代码完全开源 github 欢迎fork star 相关文章 pclpy安装 文章目录 pclpy相关 开发环境 文件结构 I O读取 构造
  • Git基础操作:push提交多个文件成功后如何撤销回退某个文件,回退代码到某次commit

    之前写过类似的一篇文章 Git基础操作 push提交成功后如何撤销回退 回退代码到某次commit 按照那个示例 把期间所有commitid下的文件都会回滚掉 但是如果只想将其中某个文件回滚可以下面的示例来搞 git log OneBean
  • Broyden算法

    代码传送门 https github com taifyang optimization method Python实现 import sympy import numpy as np from numpy import matlib as
  • java毕业设计——基于Java+AI的五子棋游戏设计与实现(毕业论文+程序源码)——五子棋游戏

    基于Java AI的五子棋游戏设计与实现 毕业论文 程序源码 大家好 今天给大家介绍基于Java AI的五子棋游戏设计与实现 文章末尾附有本毕业设计的论文和源码下载地址哦 需要下载开题报告PPT模板及论文答辩PPT模板等的小伙伴 可以进入我
  • expiringmap入门初体验

    功能简介 可设置Map中的Entry在一段时间后自动过期 key过期 value同时会过期 可设置Map最大容纳值 当到达Maximum size后 再次插入值会导致Map中的第一个值过期 可添加监听事件 在监听到Entry过期时调度监听函
  • linux系统中docker服务和普通服务对外访问端口不通的问题

    linux系统中docker服务和普通服务对外访问端口不通的问题 前一段时间 在一个新的centos 7 4 服务器上运行项目 共有四个项目 因为特殊原因 两个是通过docker 运行 另外两个是通过nginx和tomcat 运行 当运行起
  • 电脑配置tomcat环境变量

    Tomcat在使用前需要配制环境变量 这里以Tomcat9为例进行配置 下载Tomcat压缩包 Tomcat8 链接 https pan baidu com s 109DSHjX3 Gk7lVRVre3xxw 提取码 lsro Tomcat
  • 使用maven依赖的方式引入jQuery

    2019独角兽企业重金招聘Python工程师标准 gt gt gt 加入依赖
  • 栈、队列的链式存储结构

    栈 再说链表的实现栈之前 我们先回顾一下什么是栈 栈基本概念 栈 stack 是限定在表尾进行插入和删除操作的线性表 或单链表 只能在一段进行插入和删除 因此不存在 在中间进行插入 栈顶 top 允许插入和删除的一端 而另一端称为栈底 bo
  • 指定CUDA版本失败的解决方案

    新电脑安装的WIN11系统 因为CUDA只有11和12目前能装到WIN11上 所以就装了一个CUDA 11 7 但是编译PBRT失败 所以无奈之下又装了CUDA 12 但是因为我有的代码需要CUDA 11里的函数 这些函数在CUDA12里被
  • python编程:numpy包

    numpy是使用Python进行科学计算的基本软件包 它包含以下内容 强大的N维数组对象 复杂的 广播 功能 集成C C 和Fortran代码的工具 有用的线性代数 傅立叶变换和随机数功能 我们先比较一下numpy和list的运算速度 比如
  • matlab图像处理系列:图片圈数识别+编号标记位置

    matlab图像处理系列 图片圈数识别 编号标记位置 一 app界面介绍 二 实现过程 step1图像二值化 step2 图像close 做差 step3 像素阈值处理 step4 清除小区域 step5 识别联通区域 并在原图上标记 三
  • 3D空间包围球(Bounding Sphere)的求法

    引言 在3D碰撞检测中 为了加快碰撞检测的效率 减少不必要的碰撞检测 会使用基本几何体作为物体的包围体 Bounding Volume BV 进行测试 基本包围体的碰撞检测相对来说便宜也容易的多 所以如果在基本包围体的碰撞检测中都没有通过的
  • Docker Registry深度历险

    目录 前言 环境 问题缘起 安装本地Registry minikube访问共享image 前言 上篇我们对Docker整体有了一定了解 知道了其中一个核心概念是Registry 下来就进行更深入的学习 环境 环境 mac mini M1芯片
  • JNA传入char[][]和具有联合体结构对象数组

    工作中根据施工现场需要 我们需要通过API接口获取对方系统内数据 但是API接口方法参数如下 DWORD getSnapshot DBPH h char Names 80 TVVAL tvs int size 其中包含了char的双重数组
  • C ++的单例模式

    单例模式 对应一个类只能生成一个对象 include
  • python列表中获取最长的字符串

    从列表中找出最长的字符串 有两种方式 一种用for循环比较 另一种是python的max方法 使用的txt文件格式 方法一 使用for循环代码 def get longest name school max length 0 longest
  • linux下使用gettimeofday函数获取程序执行时间

    一 介绍 linux下为了获取某个程序的执行时间 我们通常使用gettimeofday 函数 此函数声明在sys time h文件中 此函数接收两个结构体变量地址 分别为timeval timezone 两个结构体声明如下 struct t
  • 微软更新补丁目录查询

    微软更新补丁目录查询下载 传送门 在右上角的搜索框输入补丁编号即可 比如 KB5003638
  • 适合写API接口文档的管理工具有哪些?

    现在越来越流行前后端分离开发 使用ajax交互 所以api接口文档就变的十分有意义了 目前市场有哪些比较优秀的接口文档管理工具呢 1 MinDoc 网址 https www iminho me MinDoc 是一款针对IT团队开发的简单好用