请选择 进入手机版 | 继续访问电脑版

马上加入IBC程序猿 各种源码随意下,各种教程随便看! 注册 每日签到 加入编程讨论群

C#教程 ASP.NET教程 C#视频教程程序源码享受不尽 C#技术求助 ASP.NET技术求助

【源码下载】 社群合作 申请版主 程序开发 【远程协助】 每天乐一乐 每日签到 【承接外包项目】 面试-葵花宝典下载

官方一群:

官方二群:

接口文档生成工具

  [复制链接]
查看2986 | 回复5 | 2020-10-28 14:07:35 | 显示全部楼层 |阅读模式
本帖最后由 测试人生路 于 2020-10-28 17:16 编辑

一、为什么要写接口文档?
1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。
2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发,项目维护中或者项目人员更迭,方便后期人员查看、维护
二、接口文档的格式
接口主要分为四部分:方法、uri、请求参数、返回参数

1.png


三、接口文档生成工具
apipost一款很不错的接口测试工具,它可以生成各种格式的接口文档,有在线版的,markdown格式和word格式的接口文档。
点击分享当前接口

2.png


分享

3.png


复制链接在浏览器中打开

4.png


下载其他格式的接口文档

5.png


word格式的接口文档(word只支持json格式的排版,所以百度放回的数据格式在word中显示不规范)

6.png


单个接口的word格式的接口文档可以免费下载,下载多个简单文档和一个项目的接口文档的时间就需要开会员了。
还有就是apipost下载多个word格式的接口文档的时候,每个接口是单独的接口文档需要合并。wps和office里面都有合并功能。
在插入中的对象中找到文件中的文字然后点击选择所有接口就可以合并了。

7.png



8.png



9.png


这就是接口文档生成工具
apipost下载地址:https://www.apipost.cn/?dt=20201028

*滑块验证:
您需要登录后才可以回帖 登录 | 立即注册

本版积分规则