接口文档是一个项目开发中必需的说明文档,但时接口文档编写起来比较费事费力。本文为大家推荐一款特别好用的接口文档生成工具--apipost
apipost是一款国产的接口测试和接口文档生成的工具。其中它接口文档生成的功能特别强大。
打开apipost编写一个登录的接口请求
![](https://i-blog.csdnimg.cn/blog_migrate/fe1a2fce56b20b954de4f4b9646d6ce8.png)
它这里有两个功能,成功响应示例及文档和错误响应示例及文档
![](https://i-blog.csdnimg.cn/blog_migrate/fb3fb239a555c2e15cfec71476843379.png)
成功响应示例文档,我们点击从现有响应结果导入和导出字段,获得如图效果
分享文档查看
![](https://i-blog.csdnimg.cn/blog_migrate/0fc3fa192130b9daafc805198a2c68d0.png)
还可以添加错误响应示例文档
![](https://i-blog.csdnimg.cn/blog_migrate/bdab18c49cad4fa8103527d030fad77f.png)
分享查看,成功和失败的响应示例都会出现<
接口文档是一个项目开发中必需的说明文档,但时接口文档编写起来比较费事费力。本文为大家推荐一款特别好用的接口文档生成工具--apipost
apipost是一款国产的接口测试和接口文档生成的工具。其中它接口文档生成的功能特别强大。
打开apipost编写一个登录的接口请求
它这里有两个功能,成功响应示例及文档和错误响应示例及文档
成功响应示例文档,我们点击从现有响应结果导入和导出字段,获得如图效果
分享文档查看
还可以添加错误响应示例文档
分享查看,成功和失败的响应示例都会出现<