API管理神器—Apipost

Posted 2022-12-19 ΘLLΘ

API管理神器—Apipost

1.背景

作为互联网工作者，只要是从事开发的，无论前端、后端、测试。
而一般完成整个接口的管理的解决方案如下：

1. 使用 Swagger 管理 API 文档
2. 使用 Postman 调试 API
3. 使用 RAP等根据 Mock API 数据
4. 使用 JMeter 做 API 自动化测试

可以看出每个步骤使用的工具不同，这样就需要维护不同根据之间的数据一致性，从而造成一定的风险和低效率。除此之外，不同工具之间需要共同服务一个对象，这样会造成协作低效，出问题的几率大大增强！
而我们今天介绍的Apipost神器，完美解决了以上的问题。
Apipost的定位是：
Postman + Swagger + Mock + JMeter
Apipost是自动化测试一体化协作平台。通过同一个系统管理文档的定义、接口调试、数据Mock、接口测试。这样保证了四个步骤数据的一致性，开发效率也更高！

Apipost具有如下优点：

1. 一键快速生成文档：接口文档的撰写非常麻烦，很多属于重复工作，效率低下。接口参数填写完毕后，只要在 Apipost 按下“分享文档”按钮，就会一键自动生成漂亮、规范的文档，并且可以自定义分享有效期及权限。
2. 团队成员间可实时协作：针对团队成员间协作不同步，数据保存有冲突，无法追溯变更记录的情况，多人在线协作时，Apipost 支持数据实时同步，有冲突解决机制，并且可以追溯协作日志。
3. 客户端支持不登录使用：用户处于局域网环境时（或者公司对网络限制严格），Apipost 客户端支持不登录使用。
4. 客户端支持离线脱机使用：即使在拔掉网线的情况下，仍可以正常打开 Apipost 客户端的进行大部分操作。
5. 参数库描述：很多接口往往具有大量相同名称、相同意义的参数，每次手动重复录入，非常耗时、低效。Apipost 通过自定义参数描述库，可以将大量参数进行预注释，并在输入参数时支持自动填充描述，节省了我们不少重复录入参数描述的时间。
6. Websocket测试功能：另外，全新Apipost6.1版本重点推出用户屡次提到的Websocket测试功能。

2.下载&基本使用

Apipost支持Windows、Linux、Mac等多种环境的多个版本。
具体下载地址：

• Web版下载地址（直接使用）
• 客户端下载地址

可以看到具体下载页面，根据自己电脑环境，点击下载安装对应版本即可：

Apipost还提供了官方的使用文档
可以帮助我们更快上手使用。
安装Apipost后，打开软件注册登录后，我们来看看首页面的一些功能：

可以看出Apipost的页面简洁易懂，功能全面。
我们点击Apipost提供的示例接口中的登录功能，看看详细的接口页面，在这里可以调试接口：

3.具体功能

接下来我们看看Apipost几个特别好用的功能。

3.1 文档分享

Apipost解决了传统API管理工具的痛点：无法分享文档，而Apipost可以简单的做到这一点。
如果我们要把这个接口分享给别人，我们点到接口页面：

可以看出右上角有一个分享按钮，点开：

不仅可以定义有效时间还可以定义是否需要密码查看，分享后，别人只需要打开链接即可看到接口的详细定义，超级方便！

3.2 团队协作

我们都知道，当我们在企业工作，避免不了团队开发，这时候团队协作就显得格外重要。而Apipost则提供了丰富的团队管理功能。
点击团队按钮：

详细页面。可以看到Apipost对团队的管理非常详细，对自己参与和管理的项目有明确分组。

可以看到右边还有增加读写工位：

1. 读写工位：绑定到读写工位的账号，一旦被添加到某项目的协作人员，那么他将拥有对该项目下所有接口、文档、目录、环境变量等的增、删、改、查权限。
2. 只读工位：绑定到只读工位的账号，一旦被添加到某项目的协作人员，那么他只拥有浏览、查看当前项目下接口、文档、目录、环境变量的权限。除在调试接口时可以对参数值进行更改外，不能进行诸如：新建接口、修改接口等操作。

左下角的回收站：
Apipost回收站的意义是为了防止某些误删除操作导致的数据彻底丢失。在这里可以返回误删的项目和接口等数据。

4.总结

总的来说Apipost是一款非常优秀的API管理工具，ApiPost产生的初衷是为了提高研发团队各个角色的效率！产品的使用受众为由前端开发、后端开发和测试人员以及技术经理组成的整个研发技术团队。
Apipost通过协作功能将研发团队的每个角色整合打通。它解决了一些postman和swagger的痛点。帮助我们团队更好的开发！
Apipost还有许多好的功能，具体可以看看：

1. 使用文档
2. 视频教程
3. 官方网站