1、接口規(guī)范

一、接口測試

1. 傳統(tǒng)風格接口

• 實現(xiàn)方式：統(tǒng)一采用GET和POST方法實現(xiàn)所有操作（增刪改查），不嚴格遵循HTTP協(xié)議規(guī)范
• URL特點：
  • 一個操作可對應(yīng)多個URL（如查詢用戶有3種URL形式）
  • URL中直接體現(xiàn)操作類型（如getUser/addUser/updateUser）
  • 資源與URL非一一對應(yīng)關(guān)系
• 狀態(tài)碼：統(tǒng)一返回200表示成功，不使用其他狀態(tài)碼
• 典型示例：
  • 查詢用戶：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）例題:接口規(guī)范RESTful風格樣式

• 基本概念：Representational State Transfer縮寫，是一種網(wǎng)絡(luò)應(yīng)用程序設(shè)計風格
• 核心特點：
  • 面向資源：URL僅定位資源（名詞表示），不包含操作
  • HTTP方法規(guī)范：
    • GET：查詢（查所有用戶/users，查單個/users/1）
    • POST：新增（/users）
    • PUT：修改（/users/1）
    • DELETE：刪除（/users/1）
  • 狀態(tài)碼規(guī)范：
    • 200：查詢成功
    • 201：創(chuàng)建/修改成功
    • 204：刪除成功
• 優(yōu)勢：提供統(tǒng)一規(guī)范，便于團隊協(xié)作和提高效率
• CRUD操作：Create(增)、Retrieve(查)、Update(改)、Delete(刪)的簡稱

3. 小結(jié)

• 傳統(tǒng)風格特點：
  • 方法混用：POST可完成增刪改查
  • URL混亂：資源和操作混合，同一操作多URL
  • 狀態(tài)碼單一：統(tǒng)一200
• RESTful風格特點：
  • 方法規(guī)范：嚴格對應(yīng)HTTP協(xié)議方法
  • URL唯一：僅表示資源路徑
  • 狀態(tài)碼全面：使用201/204等不同成功碼
• 識別方法：
  • 傳統(tǒng)風格：只使用GET/POST
  • RESTful風格：使用GET/POST/PUT/DELETE
• 適用場景：
  • 傳統(tǒng)風格：老舊系統(tǒng)維護
  • RESTful風格：新項目開發(fā)

二、接口規(guī)范總結(jié)

1. RESTful風格接口特征

• HTTP方法映射：接口方法與HTTP協(xié)議請求方法一一對應(yīng)
  • GET對應(yīng)查詢操作
  • POST對應(yīng)新增操作
  • PUT對應(yīng)修改操作
  • DELETE對應(yīng)刪除操作
• URL設(shè)計原則：
  • URL與資源一一對應(yīng)
  • 不能從URL直接看出操作類型，需結(jié)合請求方法識別
• 狀態(tài)碼規(guī)范：
  • 修改用戶返回201（PUT）
  • 刪除用戶返回204（DELETE）
  • 查詢用戶返回200（GET）
  • 添加用戶返回201（POST）

2. 傳統(tǒng)風格與RESTful對比

• 傳統(tǒng)風格接口：
  • 方法限制：僅使用GET和POST兩種方法
  • URL特點：不唯一，混合定義資源和操作
  • 狀態(tài)碼：統(tǒng)一返回200狀態(tài)碼
• RESTful風格接口：
  • URL設(shè)計：唯一且僅定位資源，不包含操作
  • 方法規(guī)范：嚴格遵循HTTP協(xié)議方法定義
  • 狀態(tài)碼：靈活使用標準HTTP狀態(tài)碼（200/201/204等）

3. 核心區(qū)別記憶點

• 識別要點：
  • 傳統(tǒng)接口通過URL包含操作語義
  • RESTful接口通過HTTP方法表達操作意圖
• 設(shè)計差異：
  • 傳統(tǒng)風格：用POST完成所有增刪改查
  • RESTful風格：每種操作對應(yīng)獨立HTTP方法
• 實踐價值：
  • RESTful使接口設(shè)計更規(guī)范統(tǒng)一
  • 狀態(tài)碼使用更符合HTTP協(xié)議標準