Apizza 是一款轻量级的 API 文档编写工具,从调试API到生成API文档一气呵成
1. API写完想要测试?试试模拟发送一次请求
新建接口,我想模拟发送请求如下
POST https://apizza.net/rest.apizza.net/rest/v2/test/test_query_body?opt=test_query_body&getparam=good HTTP/1.1
Cache-Control: no-cache
Content-Type: multipart/form-data; boundary=---011000010111000001101001
Host: https
Content-Length: 129
-----011000010111000001101001
Content-Disposition: form-data; name="bodyparam"
bodyparam
-----011000010111000001101001--
- 如图进行进行配置
- 点击发送,查看接口返回结果
你可以查看返回数据,返回__Header__,状态码,请求时长,数据大小等等数据
2. 测试完后我想快速生成文档给前端看
- 点击切换到文档,模拟的请求信息立刻同步到文档
- 通过切换到模拟,如图点击更新文档返回示例
- 于是我们得到了完整的接口文档
- 最后我们想分享给前端开发人员查看,保存然后左上角切换到浏览模式。
- 第一个完整
的接口文档已经生成好。分享给浏览者,就可以进行查看。同时浏览者也可以切换到模拟发送请求,查看接口的可用性。不用再和后端开发者进行沟通。
3. 后记
恭喜你体验了第一个接口文档的旅程。我们的工具同时节省了前后端的开发以及沟通时间。
除此之外我们还有更多更好的功能等您来体验。