接口文档相关知识

前言：

通过前面文章 https://mp.csdn.net/mp_blog/creation/editor/134841711项目的深入，本文对接口相关知识进行补充、记录。

---

文章目录

一、接口相关信息

1.接口规范

服务器上的每一种资源，比如一个文件、一张图片都有对应的 url 地址，如果客户端需要对服务器上的资源进行操作，需要通过 http协议，执行对应动作来操作，如：获取、更新、删除。

2.HTTP常见请求方式

• GET：从数据库查询数据（偏向于获取数据，获取列表）
• POST：向服务器发送数据并保存数据（偏向于提交数据，创建用户）
• PUT：修改数据
• DELETE：删除数据

通用字段：

?limit = 10  #指定返回记录的数量

?offset = 10  #指定返回记录的开始位置

?page = 2 & per_page = 100 #指定第几页，以及每页的记录数

?sortby = name & order = asc #指定返回结果按照哪个属性排序，以及排序顺序

?tate = close #指定筛选条件

3.请求：

• url：域名与路径
• 请求方式
• 请求头，请求头里面的token，一般向开发要
• 路径参数，放在路径的参数，:message_id ,需要把 :message_id 替换成真实的参数
• 查询参数，放在路径后面加一个 ？ 字段1=值1 &（多个）字段2=值2
• 请求体，放到body

4.响应：

• 响应每个字段的解释
• 响应示例
• 错误码

5.响应体

二、MVC架构

业务分层

• router.js ：负责将请求分发给 controller 层
• controller.js：负责处理业务逻辑
• view ：负责展示页面
• model ：负责处理数据，增删改查。