【工具】目前几种常见的线上接口文档管理平台的比较
文章目录
- 一、前言
- 二、接口文档在线平台
- 1.apizza
- 1.1 文档导出html
- 1.2 导入Postman.json和Swagger.json文件
- 2. YApi
- 2.1 源码开源&免费&支持二次开发
- 2.2 [只能]内网部署
- 2.3 支持自动化测试
- 2.4 支持导入 Postman HAR Swagger JSON
- 2.5 支持导出 html markdown json
- 3. RAP 2
- 3.1 导出 Postman Collection
- 3.2 支持 mockjs
- 4. eolinker
- 4.1 功能完善
- 4.2 付费功能
- 三、文档在线平台
- 1. 语雀
- 2. 石墨文档
- 3. Github的wiki
- 四、文件管理平台
- 1. Github
- 五、总结
一、前言
作为一个公司的技术部门，就会涉及到一些文档的对接，包括但不仅局限于
- 需求文档
- 会议记录
- 接口文档
- 切图标注
对接的部门，包括但不仅局限于
- 前端和后端
- 移动端和后端
- 设计和前端
- 设计和移动端
- 产品经理和开发
- 老板和产品经理
那么，在这些沟通中产生的文档，该怎么保存、归档，该怎么阅读、使用，就成了团队协作提升沟通效率中重要的一个环节。
接下来，我列举了一些工具，供开发人员和项目管理人员选择，根据自己的实际情况选出对应的解决方案。
二、接口文档在线平台
这里处理的问题是前端和后端交互，产生的一些接口文档，这些文档格式统一，但变更很快，并且修改之后看起来并不明显，如果开发团队有异地协作和远程办公，沟通又是个问题。
1.apizza
apizza的定位是api协作管理工具 ，官网地址为 https://apizza.net/
他的首页是这样的
实际使用界面是这样的
emmmm，实际上就是一个线上版本的Postman…
有几个亮点功能，如果你正好需要的话，可以酌情加分~
1.1 文档导出html
导出的样子是这样的
很方便前端和移动端的同学阅读，不知道比那些word文档强到哪里去了~
1.2 导入Postman.json和Swagger.json文件
如果团队内使用了Postman或者Swagger的话，就会让操作更加连贯。
如果可以导出对应的文件就好了~
2. YApi
YApi旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API
网站上的特性如下
他的界面是这样的
好吧，貌似开源的项目并不是都很好看…
2.1 源码开源&免费&支持二次开发
注意的是，这个项目是开放源代码的，也就意味着更安全，更可维护，你可以直接去反馈bug，让他做的更好。
项目地址为 https://github.com/ymfe/yapi
2.2 [只能]内网部署
项目开源带来的好处就是可以自己部署到内网上，保证数据的安全性。
同时YApi不提供公共的版本供大家注册使用，也就是需要我们自己的团队必须去部署。
2.3 支持自动化测试
2.4 支持导入 Postman HAR Swagger JSON
嗯！
2.5 支持导出 html markdown json
嗯！
3. RAP 2
为什么不是RAP呢，因为"RAP1功能不会再增加啦，新项目推荐使用RAP2哦"~
RAP 2是一个可视化接口管理工具，淘宝团队做的。
RAP1就不看了，直接看RAP2的网站。
经过注册登录，RAP 2的结构更像是Github。
有一个单独的状态页面展示全网的活跃度，说明你并不孤独。
其中接口的返回值是通过填写对应的数据和规则生成的，而不是复制对应的json，这样做更有利于测试工作。
3.1 导出 Postman Collection
看来大家都习惯于兼容Postman，这也间接说明了Postman这个工具的成功~
3.2 支持 mockjs
mockjs也是淘宝团队做的工具，“生成随机数据，拦截 Ajax 请求”。
4. eolinker
https://www.eolinker.com/
免费使用，API文档管理、自动化测试、开发协作利器
在经历过 注册 -> 验证邮箱 -> 填写问卷 -> 帮助指南 之后，实例项目的接口编辑页面是这样的
从使用者的角度来讲，这个的操作更加便利，虽然也是按Postman的样式去做的~
4.1 功能完善
eolinker是一款完整的商业化的接口管理工具，基本用到的功能，在上面都能找到，并且操作和用户体验做的都不错。
4.2 付费功能
功能完善的代价就意味着，如果你想要使用全部完善的功能，就要付费购买。
并且我们可以通过https://public.eolinker.com/index/EOLINKER%20AMS%20FUNCTION%20DETAIL%2020180520.pdf 来清晰的知道付费版的功能是哪些。
三、文档在线平台
上面的平台的针对性比较高，是专业的做接口文档的，还有一种是只做文档共享的，如果我们的目的是接口文档管理，针对性就会差一些。
1. 语雀
语雀 https://www.yuque.com/ 是蚂蚁金服做的一款文档编辑共享平台。
由于文档是可以全面公开的，所以，给我的感觉更像是简书。
【工具】目前几种常见的线上接口文档管理平台的比较相关推荐
- 一款强大的API接口文档管理工具（Smart-Doc + Torna）
[本文由龙飞同学供稿] 在团队协作开发项目的时候,接口文档承担着向其他开发人员说明接口相关信息的重要任务,因此,一份清晰而又相近的接口文档至关重要. 但是,写接口文档的痛苦想必各位开发人员都体验过,明 ...
- 几款接口文档管理工具
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
- 盘点 8 款好用的 API 接口文档管理工具
随着互联网的普及和发展,API 接口已经无处不在.它已经在 Web 应用程序.移动应用程序.云计算.物联网.人工智能等领域中得到广泛应用. 例如,在金融行业中,API 接口可以被用于构建支付服务.银行 ...
- 接口文档管理工具-Postman、Swagger、RAP、DOClever
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
- 接口文档管理工具-Postman、Swagger、RAP
在项目开发测试中,接口文档是贯穿始终的.前后端开发需要在开发前期进行接口定义并形成文档,QA在功能测试和接口测试的环节也需要依赖于这些接口文档进行测试.接口文档往往以最简单的静态文档的形态存在.然而在 ...
- 在线接口文档管理工具（小幺鸡）使用说明
在线接口文档管理工具(小幺鸡)使用说明 前言 小幺鸡的地址:http://www.xiaoyaoji.cn/ 几大看点: 在线接口测试: 可视化编辑与分享: 代码开源.可以离线部署. 下面简单介绍下怎 ...
- 接口文档管理工具showDoc
随着互联网的发展,前后端分离已成为互联网项目开发的业界标准使用方式. 由此而产生的前端开发工程师和后端开发工程师的沟通效率问题. 推荐一个应此而生的文档管理工具---showdoc showdoc官网 ...
- 接口文档管理工具--Yapi安装
前言 现在咱们做的项目都是前后端分离的,这样就可以保证前端和后端可以同时进行,但是同时会出现一个问题->前端不知道咱们服务器的接口是怎么定义的,不知道里面的参数应该如何传递.这个时候就需要使用接 ...
- java 接口文档工具_一款Java基于注释的接口文档生成工具
一. 痛点 你还在手动维护接口文档嘛,花一个下午不停的复制粘贴代码里面的注释 接口字段变动,还得去更新文档,更新不及时导致文档不同步 或者你使用了swagger之类的基于注解,依靠运行时的文档工具,看 ...
最新文章
- python中的np where_numpy中的np.where
- 这里有8个流行的Python可视化工具包，你喜欢哪个？
- Mysql带返回值与不带返回值的2种存储过程
- VC++的dll中接收消息
- AT3611-Tree MST【点分治,最小生成树】
- python怎么隐藏输入法,隐藏输入法和弹出输入法
- bzoj 4561: [JLoi2016]圆的异或并（扫描线+set）
- jquery水平垂直居中_Java Web应用程序集成的jQuery UI选项卡（水平和垂直）示例
- SpringBoot解决驼峰命名 ---返回Json实体类属性大小写问题
- linux ac 命令
- VMware16虚拟机：下载和安装教程
- QT designer 控件自适应
- 小米路由器4A千兆版c341编程器刷breed.bin详细教程
- 02-ElasticSearch创建索引
- 拍案惊奇——软件调试实战训练营
- 华为机考攻略(python)--字符串操作【9题】(第四题*HJ33整数与IP地址间的转换)
- GLES2.0中文API-glBindFramebuffer
- linux控制主机风扇转速,开发环境 - Linux下设置机箱上的风扇转速
- 准备1500 RMB Go云南！！
- risc-v vector扩展1.0版本解读（riscv-v-spec-1.0）