接口文档生成详细教程
测试人生路
共 422字,需浏览 1分钟
·
2020-11-11 12:03
接口文档是一个项目开发中必需的说明文档,但时接口文档编写起来比较费事费力。本文为大家推荐一款特别好用的接口文档生成工具--apipost
apipost是一款国产的接口测试和接口文档生成的工具。其中它接口文档生成的功能特别强大。
打开apipost编写一个登录的接口请求
它这里有两个功能,成功响应示例及文档和错误响应示例及文档
成功响应示例文档,我们点击从现有响应结果导入和导出字段,获得如图效果
分享文档查看
还可以添加错误响应示例文档
分享查看,成功和失败的响应示例都会出现
它还支持html、markdown和word格式的接口文档
看一下word格式的接口文档效果(word只生成成功响应示例文档)
这就是apipost生成接口文档的具体流程了
工具下载地址:https://www.apipost.cn
评论
Evalon4JJava 接口文档生成工具
Evalon4J是一个Java接口文档生成工具,直接通过命令行使用,支持Spring-MVC,JAX-RS,Swagger2.0等多种框架注解。同时它是付费产品 RabiAPI 使用的底层框架,通过静
Evalon4JJava 接口文档生成工具
0
Apidoc-phpAPI 接口文档生成工具
Apidoc是一个通过解析注解生成API接口文档的PHPcomposer扩展,支持在线调试、Mock数据、Md文档等功能。 全面的注解引用、数据表字段引用,简单的注解即可生成Api文档,而Apidoc
Apidoc-phpAPI 接口文档生成工具
0