接口文档是一个项目开发中必需的说明文档,但时接口文档编写起来比较费事费力。本文为大家推荐一款特别好用的接口文档生成工具--apipost

apipost是一款国产的接口测试和接口文档生成的工具。其中它接口文档生成的功能特别强大。

打开apipost编写一个登录的接口请求

enter image description here

它这里有两个功能,成功响应示例及文档和错误响应示例及文档

enter image description here

成功响应示例文档,我们点击从现有响应结果导入和导出字段,获得如图效果

enter image description here

分享文档查看

enter image description here

还可以添加错误响应示例文档

enter image description here

分享查看,成功和失败的响应示例都会出现

enter image description here

它还支持html、markdown和word格式的接口文档

enter image description here

看一下word格式的接口文档效果(word只生成成功响应示例文档)

enter image description here

这就是apipost生成接口文档的具体流程了

工具下载地址:https://www.apipost.cn