接口文档生成详细教程

测试人生路

共 422字,需浏览 1分钟

 ·

2020-11-11 12:03

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


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


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


PjRvff9Pun.png


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


1Hm9rOxBDK.png


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


U5OdjV7zK4.png


分享文档查看


71llJG3IkC.png


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


uixJbBPY5p.png


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


AdhK0OaeQr.png


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


hb7IBJuCDT.png


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


Ng4NuwgiVb.png


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


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

浏览 32
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报
评论
图片
表情
推荐
点赞
评论
收藏
分享

手机扫一扫分享

分享
举报