[toc] # 入参 > 服务器接收的参数  # 出参 > 服务器返回的参数  # 功能说明 > 该接口的主要作用, 以及相关的代码逻辑  # 上游接口 > 为当前接口提供数据的接口  # 下游接口 > 依赖当前接口提供数据的接口 # 接口顺序 > 上游接口, 连接下游接口, 形成逻辑闭环 1. 添加数据接口 1. 获取数据接口 1. 编辑数据接口 1. 删除数据接口 # 参数类型 > 参数的数据类型 1. string 1. int 1. float 1. array  # 请求方法 > http方法 1. GET（SELECT）：从服务器取出资源（一项或多项）。 1. POST（CREATE）：在服务器新建一个资源。 1. PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。 1. DELETE（DELETE）：从服务器删除资源。  # 请求路径 > URL, 用来寻找服务器 > 如果报500错误, 首先检查URL是否正确   # 状态码 > 用以表示网页服务器HTTP响应状态的3位数字代码 * 2XX: 成功，操作被成功接收并处理 `200` * 3XX: 重定向，需要进一步的操作以完成请求 `301` * 4XX: 客户端错误，请求包含语法错误或无法完成请求 `404` * 5XX: 服务器错误，服务器在处理请求的过程中发生了错误 `500`  # 错误码 > 出参的一种, 快速定位问题  # 接口大致流程 ```[sequence] participant APP as app participant 服务器 as server participant 接口逻辑代码 as python participant 数据库 as db app->server:请求接口, 通过URL寻找服务器 note over app, server: 如果没有找到服务器(URL不正确)或者服务器出错\n则返回状态码 server->python: 把接收到的数据交给逻辑代码 python->python: 接收数据, 进行逻辑处理 note over server, python : 接口验证, 如果参数有问题, 返回错误码\n如果没问题, 则根据url里的参数, 把数据分配给不同的代码\n如果逻辑处理时出错, 也返回错误码 python->db: 根据不同请求, 如有需要, 操作数据库 db-->python:返回操作结果 python->python:处理数据 note over db,python: 如果数据有误或者操作数据库失败\n返回错误码 python-->server:通过服务器原路返回给app server-->app:返回json数据 app->app:展示给用户 ```