Apipost 基于设计、开发、测试一体化协作接口管理平台

✊ 基于协作，更懂中国程序员。不止于API文档、调试、Mock
✊ Apipost = Postman + Swagger + Mock后端、前端、测试同时在线编辑，内容实时同步

一、Apipost介绍

1. 概述

• Apipost前期对标的是Postman，支持后端、前端、测试同时在线编辑，内容实时同步，15人以下的团队和个人完全免费，针对高校和培训机构也是完全免费的，企业也可以根据需要进行私有化部署。
• Apipost=Postman+Swagger+Mock+流程测试。
• Apipost产品的使用受众为前端开发、后端开发和测试人员以及技术经理组成的整个研发技术团。队。Apipost产品研发的初衷是为了提高研发团队各个角色的效率。
• Apipost通过协作功能将研发团队的每个角色整合打通。

2. 为什么选择Apipost

• 针对后端开发人员

调试接口 & 快速生成接口文档

Apipost不仅仅是一个接口调试工具，更是一个接口文档快速生成工具。
后端人员可以通过Apipost在编写、测试接口的同时快速的、自动的生成漂亮、规范的接口文档。相同的时间完成2件事情，大大提升后端开发效率。

生成Mock数据

后端可以通过先编写Mock数据给前端，从而让前端提前进入接口调用、前端开发状态。

生成程序代码

Apipost提供主流语言代码自动生成功能。每编写一个接口，Apipost都支持生成主流语言代码。

• 针对前端开发人员

接口文档浏览

前端人员可以通过后端分享的接口文档地址，清晰的查看规范的接口文档。

接口数据 Mock

配合后端给定的Mock地址，先行进入研发状态。

接口调试

利用Apipost进行常规的接口调试功能。

前端代码自动生成

Apipost支持生成NodeJS、Ajax等常见前端程序代码。

• 测试人员

接口调试

利用Apipost进行常规的接口调试功能。

接口自动化测试

利用Apipost提供的断言和流程测试功能，进行接口的流程化测试。

• 研发经理

规范接口文档管理

对项目接口文档进行规范管理，方便人员流动带来的文档丢失、不易查找等困惑。

提升整体研发团队效率

把控整体进度，大大提升整个研发团队效率！

• Apipost逐渐成为求职、面试必备技能

随着Apipost的快速普及，越来越多的企业已逐渐将掌握Apipost的使用作为入职必备技能。以下截图均摘录自招聘平台：

二、Apipost亮点

Apipost官网地址：
https://www.apipost.cn?token=201f9a70125d9a03963da7505ce03ea2

Web版链接（不用下载）
https://console.apipost.cn/register?token=201f9a70125d9a03963da7505ce03ea2

客户端下载地址：
https://www.apipost.cn/download.html?token=201f9a70125d9a03963da7505ce03ea2

1. 亮点功能一

• 一键快速生成文档

1. 点击分享文档2. 复制外网链接并打开文档地址就可以看到了完整的接口文档

​

• 接口文档的撰写非常麻烦，很多属于重复工作，效率低下。接口参数填写完毕后，只要在 Apipost 按下“分享文档”按钮，就会一键自动生成漂亮、规范的文档，并且可以自定义分享有效期及权限。

2. 亮点功能二

• 团队成员间可实时协作

1. 点击右上方的邀请协作，输入被邀请方的邮箱，点击确定添加即可
   2. 点击确定按钮后，可添加多个协作者，最后添加添加

3. 添加成功后，进入团队即可看到新添加的团队成员了

4. 被邀请的成员也能在消息中看到此邀请

5. 登录tester_01账户，对项目下的登录接口进行修改，然后点击保存

6. 回到超管cdtaogang工作台，可以在协同日志中看到tester_01成员协作日志

7. 此时登录接口的参数为tester_01协作修改后的参数，即完成了团队协作

• 针对团队成员间协作不同步，数据保存有冲突，无法追溯变更记录的情况，多人在线协作时，Apipost 支持数据实时同步，有冲突解决机制，并且可以追溯协作日志。

3. 亮点功能三

• 客户端支持不登录使用

1. 退出登录Apipost客户端，此时团队和项目均为离线2. 直接在离线项目下创建目录，添加接口，即可完成不登录使用

​

• 用户处于局域网环境时（或者公司对网络限制严格），Apipost 客户端支持不登录使用。

4. 亮点功能四

• 客户端支持离线脱机使用

1. 断网后，任然可以打开Apipost客户端程序
   2. 断网情况下载客户端一样可以查看APIs接口数据、笔记等

​

• 即使在拔掉网线的情况下，仍可以正常打开 Apipost 客户端的进行大部分操作。

5. 亮点功能五

• 参数描述库

1. 点击参数描述库，其中会看到我们发送接口请求后，系统会为我们自动保存的参数描述
   2. 当我们为登录接口添加一些见名知意的参数后，系统会自动补充参数描述

3. 此时点击保存按钮后，在查看参数描述库，可以看到系统自动为我们临时保存了

4. 大家可以通过参数描述库下方进行添加参数描述，或者导入参数描述，切记最后需要点击保存按钮进行保存，这样就不会因重启软件而丢失参数描述了

5. 除了以上方式进行参数描述保存以外，还可以通过快速导入按钮进行导入即可

• 很多接口往往具有大量相同名称、相同意义的参数，每次手动重复录入，非常耗时、低效。Apipost 通过自定义参数描述库，可以将大量参数进行预注释，并在输入参数时支持自动填充描述，节省了我们不少重复录入参数描述的时间。

6. 亮点功能六

• Websocket测试功能

1. 点击“+”按钮，新建websocket接口
   2. 输入websocket地址，点击连接

3. 连接成功后，服务器返回详细列表

4. 向服务端发送消息

• 另外，全新Apipost6.1版本重点推出用户屡次提到的Websocket测试功能。

三、Postman对比Apipost

Postman（印度软件）Apipost（中国软件）介绍

• Postman 最早是google的一个插件存在的，但是又google退出中国以及postman团队对工具的定位，主攻pc端app的开发及优化，现在的google插件已经很少再使用了，Postman是Google开发的一款接口测试工具，提供了独立的安装包，不再依赖于Chrome浏览器了。同时支持MAC、Windows和Linux版本能够模拟各种HTTP Request如GET、POST 、header、 PUT、 DELETE…等等请求中还可以发送文件(图片、文本文件等)、额外的header等，实现特定的接口测试，能够高效的帮助后端开发人员独立进行接口测试。

• Apipost是一个支持度团队多人实时协作、一键生成在线文档的API调试的管理工具，支持模拟GET、POST、PUT、HEADER、DELETE、WebSocket等多种等请求且是一个国产的比Postman更懂中国程序员的Web API的测试软件，提供Window、Mac、Linux版本客户端下载以及在线Web版本使用，支持后端、前端、测试同时在线编辑，内容实时同步，同时由于它是国产软件，完全中文界面更加友好，也符合中国开发者的使用体验。Apipost不仅仅是一个接口调试工具，更是一个接口文档快速生成工具。后端人员可以通过Apipost在编写、测试接口的同时快速的、自动的生成漂亮、规范的接口文档。相同的时间完成2件事情，大大提升后端开发效率。

官网PostmanApipost - API 文档、调试、Mock、测试一体化协作平台开发Google开发国产开发收费部分收费15人以下的团队和个人完全免费语言英语中文版本最新版V9.0.9最新版V6.1.0上手速度纯英文，上手较慢纯中文，开箱即用学习成本纯英文，学习成本高昂国内团队开发、支持、学习起来无压力使用流程度服务器在国外，登录经常掉线，协作网络延迟国内高速云服务器，流畅无压力协作功能支持协作，但是价格昂贵支持协作，价格是postman的1/5生成接口文档生成接口文档功能十分鸡肋，不适合国内习惯可以完美支持快速生成漂亮的接口文档界面新建发送POST请求（表单提交）发送POST请求（JSON数据提交）发送WebSocket请求MOCK响应断言生成代码接口文档

四丶Apipost使用体验

众所周知，目前市面上有很多API测试管理工具，如 Postman、Apipost 等等。最近博主被各大公众号以及博客疯狂推送“再见 Postman，我选择 Apipost”类似的文章，作为全栈测试的我便也到官网去下载Apipost进行使用 ，这里简单说下博主我的切身使用体验。

1.优缺点

Apipost的优点

总体来说，对于国人而言 Apipost 还是比较香的，功能比较多，非常适合国人的习惯，有以下几个功能我个人比较喜欢。

1-未登陆使用Apipost

痛点：
很多用户处于局域网环境（军工企业单位或者对网络限制严格的公司），此时在未登录的情况下则无法使用旧版或者市面上大部分的API管理工具。

解决方案：
针对未登陆（游客）的状态，Apipost 完全支持以下操作：
功能离线支持新建/编辑/发送 接口支持新建/编辑 目录支持新建/编辑 文本文档支持新建/编辑 环境及环境变量支持新建/编辑 全局参数支持新建/编辑 参数描述库支持新建/编辑 Cookie支持新建/编辑 笔记支持
用户一旦注册，数据会自动同步至注册账号的私有项目。

2-断网情况下，已登陆使用Apipost

痛点：
用户在登录状态下，受公司网络故障或者服务器出现的异常，此时导致无法使用旧版或者市面上大部分的API管理工具。

解决方案：
针对断网情况下，已登陆用户，Apipost 完全支持以下操作：
功能离线支持新建/编辑/发送 接口支持新建/编辑 目录支持新建/编辑 文本文档支持新建/编辑 环境及环境变量支持新建/编辑 全局参数支持新建/编辑 参数描述库支持新建/编辑 Cookie支持新建/编辑 笔记支持
网络恢复后，数据会自动同步至其他协作者。

3-团队成员间的实时协作功能

痛点：
针对团队成员间协作不同步，数据保存有冲突，无法追溯变更记录的情况。

解决方案：
多人在线协作时，Apipost 支持数据实时同步，有冲突解决机制，并且可以追溯协作日志：
功能协作支持前后端人员支持前后端+测试人员支持后端人员支持测试人员与测试人员支持

4-一键快速生成文档

痛点：
接口文档的撰写非常枯燥麻烦，很多属于重复工作，效率低下。

解决方案：
接口参数填写完毕后，Apipost 支持一键自动生成漂亮、规范的文档，并且可以自定义分享有效期及权限。

5-参数库描述

痛点：
很多接口往往具有大量相同名称、相同意义的参数，每次手动重复录入，非常耗时、低效。

解决方案：
Apipost 通过自定义参数描述库，可以将大量参数进行预注释，并在输入参数时支持自动填充描述，节省了我们不少重复录入参数描述的时间。

Apipost的缺点

总体来说，Apipost 是一款非常不错的国产管理工具，更适用用国人的习惯，同时也提供软件使用文档及视频教程，国产软件对国人来说学习成本非常低，对于即将从事或者已经从事软件开发、测试的人来说是一款非常值得推荐的工具，但世上没有0缺陷的软件，例如Apipost虽然在6.0 版本新增了很多功能，但还是出现了不少小BUG，而Apipost的研发团队花费了9天时间修复了6.0版本的BUG推出了6.0.1版本，对于一个成立不久的团队来说，未来的路还很长，期待Apipost团队给我们带来更多功能的稳定版本。
1、Apipost在API的监控及分析存在缺失。
2、Apipost产品的更新迭代速率还不够快。
3、Apipost用户在社区反应的问题得不到及时反馈。

2.小技巧

小技巧之：快速导入参数

Apipost支持多种格式的参数导入，大大节省了测试时间：

Key-Value方式：

Raw-JSON方式：

小技巧之：参数注释自动识别

填写参数描述是我们最烦恼的一件事情，尤其对于很多接口来说，往往具有大量相同名称、相同意义的参数，假如每次都需要手动录入，将会是一件非常耗时、低效的事情。
除了在参数描述库进行维护外，只要你在Apipost中填写过参数描述，Apipost都会帮我们自动识别出来此参数描述，如下图中填写了参数名kw的描述：

此时新建接口，填写kw参数名，再点击参数描述，自动会呈现出输入过的参数描述：

小技巧之：定位当前接口

当闭合左侧的目录是闭合的，窗口有多个请求且左侧目录数目较多时，想快速找到当前接口所在的目录就比较麻烦。
Apipost提供了“定位当前接口” 功能（见下图），可以快速打开当前正在编辑的接口、文档所在的目录：

小技巧之：接口路径变量提取

例：cdtaogang.club/api/users/1
Apipost支持把如上例restful风格链接中的

uid

也就是

1

作为参数单独提出来比较方便调试和解释。
只需要在Apipost中将URL路径中的ID设置为

:uid

（如下图所示）即可

小技巧之：快速克隆（复制）项目

有时候需要复制一个项目的数据
Apipost提供了克隆项目功能：

选择要克隆的项目，点击确定克隆即可

小技巧之：提取实时响应中的字段和描述

有时候在做接口测试时，对于响应数据字段很多的时候，通过肉眼去查看很头疼。
Apipost提供了“

从现有响应导入

” 和“

提取字段和描述

”功能（见下图），可以提取接口返回的响应数据中的字段和描述：

3.总结

博主以前做接口测试时基本都是用的Postman、Swagger等工具，虽然这些工具都挺很不错，但由于是国外开发的对于英语不是很好的人来说很不方便且服务器在国外，登录经常掉线，协作网络延迟高，生成的接口文档数据不够完整漂亮。这两天用了下国产的接口测试工具Apipost，中文界面真的不要太爽且到目前最新版本推出了WebSocket测试功能，对于Postman的功能基本覆盖了，并且产品的细腻、功能的完善、操作的流畅，服务于后端、前端、测试更好的协同办公软件，提高项目整体的交付速度，对于小白来说学习无压力，测试人员直接使用没有任何上手难度，说实话国产软件能做到这样已经很不错了，在这里博主我隆重向大家推荐！