接口API文档

image.png

erp项目或者其他开发项目，或多或少都会接触到关于接口的任务，可能是编写接口api文档，也可能是调用接口。无论是写或者用，都避免不了要读懂了解接口文档的组成。

1.接口文档是什么

在项目开发汇总，web项目的前后端是分离开发的。应用程序的开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

2.为什么要写接口文档？

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

2）项目维护中或者项目人员更迭的时候，方便后期人员查看、维护

3.回顾接口的知识

要了解接口文档的规范，首先要了解接口。接口分为四部分：请求方法、url、请求参数、返回参数：

1）方法：常用的方法就是下面的四种：GET PUT POST DELETE

2）url：以/a开头，如果需要登录才能调用的接口（如新增、修改；前台的用户个人信息，资金信息等）后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词。get方法，若果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾。uri地址里不逊于出现大写字母，如果是两个单词拼接，用/分开

3）请求参数和返回参数：请求参数和返回参数都分为：字段、说明、类型、备注、是否必填这5列。

字段：类的属性

说明：中文释义

类型：属性的类型，只有String、Number、Object、Array四大类

备注：一些解释语，或者写简单的示例

4）返回参数，要分两种情况讨论：

只返回接口调用成功或者失败：code、reason

返回参数：字段、类型

3.常见问题

一份规范的接口文档应该包括什么内容

4.解决方案

除了上面提到的请求方法、url、请求参数、返回参数以外，还应该添加接口示例、接口文档版本号、版本修改内容、版本修改时间、修改人，错误代码等。

5.示例：

下面是在网站上找到的一个接口文档示例

image

image