使用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测试接口
首先&#x