接口&接口文档

一、接口简介

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

接口可以简单的理解为一个黑盒子，从一边输入参数，另外一遍输出参数，黑盒子中的逻辑控制输入输出。

在web后端开发中，接口接受前端（browser、app、client）传入的数据，处理之后要么返回给前端想要的数据（json）要么将数据存储到数据库中（MySQL、redis）

二、接口文档

接口文档又叫（规范性文档）。接口文档有规范的格式和内容要求，后端按照接口协议接收前端传递的合法数据和返回符合的规范的数据，前端按照接口协议传递符合规范的数据和对后端返回的数据依据展示的需要做处理

三、接口文档编写规范

1、内容

文档包含以下内容：

1. 接口说明
2. 请求方式（GET/POST/RETRIEVE/UPDATE)
3. 调用URL（接口地址）
4. 请求参数，包含参数类型及其限制条件
5. 返回参数说明（返回包结构体）

2、示例

接口说明：注册接口