接口文档是一个我的项目开发中必须的阐明文档,但时接口文档编写起来比拟麻烦费劲。本文为大家举荐一款特地好用的接口文档生成工具 –apipost
apipost 是一款国产的接口测试和接口文档生成的工具。其中它接口文档生成的性能特地弱小。
关上 apipost 编写一个登录的接口申请
它这里有两个性能,胜利响应示例及文档和谬误响应示例及文档
胜利响应示例文档,咱们点击从现有响应后果导入和导出字段,取得如图成果
分享文档查看
还能够增加谬误响应示例文档
分享查看,胜利和失败的响应示例都会呈现
它还反对 html、markdown 和 word 格局的接口文档
看一下 word 格局的接口文档成果(word 只生成胜利响应示例文档)
这就是 apipost 生成接口文档的具体流程了
工具下载地址:
ApiPost – 可间接生成文档的 API 调试、管理工具www.apipost.cn