关于接口文档:接口文档编写

一. 什么是接口

API（Application Programming Interface）即利用程序接口，能够工作是一个软件组件或一个 Web 服务与外界进行交互的接口，在这里接口能够和 API 划等号。

二. 为什么编写接口文档

1、我的项目开发过程中前后端工程师有一个对立的文件进行沟通交流开发

2、我的项目保护中或者我的项目人员更迭，不便前期人员查看、保护

3、测试人员验证查看接口是否正确

三. 接口文档有谁编写

正规的团队单干或者是我的项目对接，接口文档是十分重要的，个别接口文档都是通过开发人员写的。一个工整的文档显得是非重要。

四. 接口文档格局

1. 在线版格局

2.word 版格局

这就是接口文档的格局如何编写的了，我这里不是用本人手写的，而是用的一款叫 apipost 的接口测试和接口文档生成工具生成的，它还能够生成 html 和 markdown 格局的接口文档。

不想本人写文档的同学能够是去试试这款软件。