1、为何要写接口文档？
- 正规的团队合做或者是项目对接，接口文档是很是重要的，通常接口文档都是经过开发人员写的。一个工整的文档显得是非重要。
- 项目开发过程当中先后端工程师有一个统一的文件进行沟通交流开发，项目维护中或者项目人员更迭，方便后期人员查看、维护
2、接口文档的格式json
接口主要分为四部分：方法、uri、请求参数、返回参数后端
3、接口文档生成工具api
apipost一款很不错的接口测试工具，它能够生成各类格式的接口文档，有在线版的，markdown格式和word格式的接口文档。浏览器
点击分享当前接口markdown
分享工具
复制连接在浏览器中打开post
下载其余格式的接口文档测试
word格式的接口文档（word只支持json格式的排版，因此百度放回的数据格式在word中显示不规范）spa
单个接口的word格式的接口文档能够免费下载，下载多个简单文档和一个项目的接口文档的时间就须要开会员了。3d
还有就是apipost下载多个word格式的接口文档的时候，每一个接口是单独的接口文档须要合并。wps和office里面都有合并功能。
在插入中的对象中找到文件中的文字而后点击选择全部接口就能够合并了。
这就是接口文档生成工具apipost