一、为什么要写接口文档?

1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的。一个工整的文档显得是非重要。

2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发,项目维护中或者项目人员更迭,方便后期人员查看、维护

二、接口文档的格式

接口主要分为四部分:方法、uri、请求参数、返回参数

enter image description here 三、接口文档生成工具

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

点击分享当前接口

enter image description here 分享 enter image description here

复制链接在浏览器中打开 enter image description here

下载其他格式的接口文档 enter image description here

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

enter image description here 单个接口的word格式的接口文档可以免费下载,下载多个简单文档和一个项目的接口文档的时间就需要开会员了。

还有就是apipost下载多个word格式的接口文档的时候,每个接口是单独的接口文档需要合并。wps和office里面都有合并功能。

在插入中的对象中找到文件中的文字然后点击选择所有接口就可以合并了。

enter image description here enter image description here enter image description here 这就是接口文档生成工具

apipost下载地址:https://www.apipost.cn/?dt=20201028