1、接口规范

一、接口测试

1. 传统风格接口

• 实现方式：统一采用GET和POST方法实现所有操作（增删改查），不严格遵循HTTP协议规范
• URL特点：
  • 一个操作可对应多个URL（如查询用户有3种URL形式）
  • URL中直接体现操作类型（如getUser/addUser/updateUser）
  • 资源与URL非一一对应关系
• 状态码：统一返回200表示成功，不使用其他状态码
• 典型示例：
  • 查询用户：GET/POST均可，URL如/getUser?id=1或/getByID?id=1
  • 添加用户：仅POST，URL如/addUser或/saveUser
  • 修改用户：仅POST，URL如/updateUser或/editUser
  • 删除用户：GET/POST均可，URL如/deleteUser?id=1

2. RESTful风格接口

1）例题:接口规范RESTful风格样式

• 基本概念：Representational State Transfer缩写，是一种网络应用程序设计风格
• 核心特点：
  • 面向资源：URL仅定位资源（名词表示），不包含操作
  • HTTP方法规范：
    • GET：查询（查所有用户/users，查单个/users/1）
    • POST：新增（/users）
    • PUT：修改（/users/1）
    • DELETE：删除（/users/1）
  • 状态码规范：
    • 200：查询成功
    • 201：创建/修改成功
    • 204：删除成功
• 优势：提供统一规范，便于团队协作和提高效率
• CRUD操作：Create(增)、Retrieve(查)、Update(改)、Delete(删)的简称

3. 小结

• 传统风格特点：
  • 方法混用：POST可完成增删改查
  • URL混乱：资源和操作混合，同一操作多URL
  • 状态码单一：统一200
• RESTful风格特点：
  • 方法规范：严格对应HTTP协议方法
  • URL唯一：仅表示资源路径
  • 状态码全面：使用201/204等不同成功码
• 识别方法：
  • 传统风格：只使用GET/POST
  • RESTful风格：使用GET/POST/PUT/DELETE
• 适用场景：
  • 传统风格：老旧系统维护
  • RESTful风格：新项目开发

二、接口规范总结

19:24

1. RESTful风格接口特征

• HTTP方法映射：接口方法与HTTP协议请求方法一一对应
  • GET对应查询操作
  • POST对应新增操作
  • PUT对应修改操作
  • DELETE对应删除操作
• URL设计原则：
  • URL与资源一一对应
  • 不能从URL直接看出操作类型，需结合请求方法识别
• 状态码规范：
  • 修改用户返回201（PUT）
  • 删除用户返回204（DELETE）
  • 查询用户返回200（GET）
  • 添加用户返回201（POST）

2. 传统风格与RESTful对比

• 传统风格接口：
  • 方法限制：仅使用GET和POST两种方法
  • URL特点：不唯一，混合定义资源和操作
  • 状态码：统一返回200状态码
• RESTful风格接口：
  • URL设计：唯一且仅定位资源，不包含操作
  • 方法规范：严格遵循HTTP协议方法定义
  • 状态码：灵活使用标准HTTP状态码（200/201/204等）

3. 核心区别记忆点

• 识别要点：
  • 传统接口通过URL包含操作语义
  • RESTful接口通过HTTP方法表达操作意图
• 设计差异：
  • 传统风格：用POST完成所有增删改查
  • RESTful风格：每种操作对应独立HTTP方法
• 实践价值：
  • RESTful使接口设计更规范统一
  • 状态码使用更符合HTTP协议标准