接口文档编写

678 阅读1分钟

一.什么是接口

API(Application Programming Interface)即应用程序接口,可以任务是一个软件组件或一个Web服务与外界进行交互的接口,在这里接口可以和API划等号。

二.为什么编写接口文档

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

2、项目维护中或者项目人员更迭,方便后期人员查看、维护

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

三.接口文档有谁编写

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

四.接口文档格式

1.在线版格式

![](https://pic2.zhimg.com/80/v2-384eefb2f8333c1d167fe33b91db8e05_720w.jpg)

2.word版格式

![](https://pic1.zhimg.com/80/v2-54689e70f8cc1f1c1adb1e82784379ac_720w.jpg)

这就是接口文档的格式如何编写的了,我这里不是用自己手写的,而是用的一款叫apipost的接口测试和接口文档生成工具生成的,它还可以生成html和markdown格式的接口文档。

![](https://pic4.zhimg.com/80/v2-abbb4b0a9a3a7566dc9a793279894117_720w.jpg)

不想自己写文档的同学可以是去试试这款软件。

www.apipost.cn​www.apipost.cn