目录

前言

基本使用教程

注册账号

创建项目

创建接口

编辑接口

​编辑

接口设计 

生成文档

接口用例

---

前言

在 web 后端开发中，开发接口之前通常需要先写接口文档，然后前后端再根据接口文档开始开发系统模块。接口文档形式多种多样，有使用共享文档的（wps共享文档），也有使用第三方接口管理平台的（比如yapi）等等。

写完接口文档后并且开发完后，就需要对接口进行自测，一般使用 postman 来调试请求接口，这时候就需要在 postman 中创建接口文档中定义的接口，输入对应的各种入参，然后请求调试。

上面的开发过程中，接口文档和调试实际上是分离的。若是在只有接口文档的情况下要对接口进行调试，就免不了要依据接口文档在 postman 中创建请求。每个接口在自己的 postman 中都需要去新建请求，而且一旦接口文档有变动，postman 中的请求还需要自己去修改，非常麻烦。

Apipost 则是解决了以上的痛点，Apipost 可以简单认为是 postman 的增强版，除了 api 的调试功能，还结合了生成 api 文档以及团队协作功能。使用 Apipost，就不再将编写接口文档和创建调试请求分离了，只需要在 Apipost 中创建调试请求，就能够直接生成实时 api 文档地址，每次改动都能够实时更新，避免前后端文档版本不一致问题，降低沟通成本。而且团队共享同一份 api 集合，避免了自己本地重复新建 api 调试请求。

基本使用教程

注册账号

注册账号后登录，默认会给账号一个私有团队，可能供 15 人的小团队来团队协作开发

若免费版的满足不了需求，则还可以付费进行团队升级

创建项目

在客户端中登录后，新建项目，会跳转到网页中进行新建项目

新建项目后就能够在客户端中使用该项目了

创建接口

在左侧树中右键，即可新建接口，子目录等等

这里先创建了一个子目录，然后在该子目录下新建接口

编辑接口

 get 请求，配置 query 模块以及响应示例（这些信息都将用于生成文档）

 post 请求，配置 body 中的 form  data 以及响应示例（这些信息都将用于生成文档）

 post 请求，配置 body 中 raw（json）以及响应示例（这些信息都将用于生成文档）

接口设计 

接口设计为详细说明提供了富文本编辑器，可以为接口编写详细说明， 描述接口的代码逻辑等等（这些信息都将用于生成文档）

生成文档

点击分享项目，即可生成一个 api 文档地址，打开该地址，即可看到在依据编辑接口和设计接口中信息生成的api文档

 

接口用例

可以为接口保存一个已经调通的示例，方便以后快速验证测试