接口文档生成详细教程
接口文档是一个项目开发中必需的说明文档，但时接口文档编写起来比较费事费力。本文为大家推荐一款特别好用的接口文档生成工具--apipost
apipost是一款国产的接口测试和接口文档生成的工具。其中它接口文档生成的功能特别强大。
打开apipost编写一个登录的接口请求
文章图片
它这里有两个功能，成功响应示例及文档和错误响应示例及文档
文章图片
成功响应示例文档，我们点击从现有响应结果导入和导出字段，获得如图效果
文章图片
分享文档查看
文章图片
还可以添加错误响应示例文档
文章图片
分享查看，成功和失败的响应示例都会出现
文章图片
它还支持html、markdown和word格式的接口文档
文章图片
看一下word格式的接口文档效果（word只生成成功响应示例文档）
文章图片
这就是apipost生成接口文档的具体流程了
工具下载地址：
【接口文档生成详细教程】ApiPost - 可直接生成文档的API调试、管理工具?www.apipost.cn
推荐阅读
- JAVA（抽象类与接口的区别&重载与重写&内存泄漏）
- 基于微信小程序带后端ssm接口小区物业管理平台设计
- 2020-04-07vue中Axios的封装和API接口的管理
- 调取接口时报404错误(ID:16)
- CICC（脑机接口，科幻几近成真（））
- ts泛型使用举例
- 记录iOS生成分享图片的一些问题，根据UIView生成固定尺寸的分享图片
- ssh生成公钥秘钥
- Java内存泄漏分析系列之二（jstack生成的Thread|Java内存泄漏分析系列之二：jstack生成的Thread Dump日志结构解析）
- 15、IDEA学习系列之其他设置（生成javadoc、缓存和索引的清理等）