使用ApiPost来设计和管理API文档

使用ApiPost来设计和管理API文档

1. 关于ApiPost

ApiPost是一个支持团队协作，并可直接生成文档的API调试、管理工具；

支持模拟POST、GET、PUT等常见请求，是后台接口开发者或前端、接口测试人员不可多得的工具 。

ApiPost具有以下特点：

• 支持接口调试的同时快速生成、一键导出api文档。开发人员再也不用头疼接口文档的编写。
• 支持离线接口调试。同时，在线版数据完全以加密的形式存储在云端，100%隐私安全保障。
• 支持Cookie管理，发送接口时，可以携带自定义的Cookie进行模拟登陆，从而方便测试一些需要登录才能访问的API

使用场景：

• 场景1：对于后端程序员，常常会写一些接口（APIs），但是在前端尚未调用之前，我们必须先自己测试下这个接口是不是正确返回了预定结果。对于一个GET请求的接口还好，我们可以直接用浏览器打开或者URL传参数查看结果，但对于POST、PUT、DELETE等接口就不能这样做了；
• 场景2：需要快速生成接口文档，如https://software-system-analysis-and-design.github.io/Dashboard/docs/API.html
• 场景3：对于一个App开发者或者一个前端，我们当然要看下后端返给我们的接口数据长什么样。当然，ApiPost就是干这件事的。

2. 使用ApiPost测试接口

首先，我们需要安装ApiPost插件，官网即可安装，安装之后打开插件，新建项目，便可以开始管理项目，下图是一个使用的简单教程

ApiPost支持POST, GET，PUT, DELETE等所有的请求方式，支持form-data，x-www-form-urlength等各种请求格式，同时也支持文件上传的方式，因此可以很方便地模拟各种请求，对后端写好的接口进行测试。

下图是使用文件上传的请求示例：

我们做开发一般都是在PC端，然而我们很多时候需要模拟移动端进行接口请求。

比如，当一个API需要根据用户不同的终端来返回不同的数据时，就需要一个工具来模拟不同的终端了。

利用接口测试工具ApiPost，就可以轻松的做到这一点。

3. 使用ApiPost生成文档

除了提供后端接口的测试外，ApiPost还可以很方便地导出文档，如https://software-system-analysis-and-design.github.io/Dashboard/docs/API.html，在接口文档中，可以在文档简述中插入接口的相关描述：

并且还可以保留之前测试的示例值，方便前端工作人员查看：

还有响应成功和响应失败的示例值，可以让前端工作人员针对不同的情况进行处理：