什么是restful？

restful是當下最流行的接口設計規范，前端和后端都必須知道的一種規范
該規范定義了接口開發中，各個流程之中

協議

客戶端在通過 API 與后端服務通信的過程中，應該 使用 HTTPS 協議

域名

API 應該部署在專用域名之下，應盡可能保持足夠簡單。如果確定 API 很簡單，不會有進一步擴展，可以考慮放在主域名下，這里有兩個常見的 URL 根例子：

• api.example.com/* 單獨一個子域名用來訪問接口
• example.com/api/* 主域名之下單獨一個空間

版本（Versioning）

所有的 API 必須保持向后兼容，你 必須 在引入新版本 API 的同時確保舊版本 API 仍然可用。所以 應該 為其提供版本支持

地址（path） 路由（router）

API 的具體網址

• URL 的命名 必須 全部小寫
• URL 中資源（resource）的命名 必須 是名詞，并且 必須 是復數形式
• 必須 優先使用 Restful 類型的 URL
• URL 必須 是易讀的
• URL 一定不可 暴露服務器架構

至于 URL 是否必須使用連字符（-） 或下劃線（_），不做硬性規定，但 必須 根據團隊情況統一一種風格

• https://api.example.com/zoos
• https://api.example.com/animals
• https://api.example.com/zoos/{zoo}/animals
• https://api.example.com/animal_types
• https://api.example.com/employees

動詞（請求方法 method）

對于資源的具體操作類型，由 HTTP 動詞表示。常用的 HTTP 動詞有下面五個（括號里是對應的 SQL 命令）。

• GET（SELECT）：從服務器取出資源（一項或多項）。
• POST（CREATE）：在服務器新建一個資源。
• PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完整資源）全更新。
• PATCH（UPDATE）：在服務器更新資源（客戶端提供改變的屬性）部分更新。
• DELETE（DELETE）：從服務器刪除資源。

url參數

所有 URL 參數 必須 是全小寫，必須 使用下劃線類型的參數形式
分頁參數 必須 固定為 page、page_size

響應（Response）

必須 選擇合適的 HTTP 狀態碼。
必須 返回 JSON 格式數據。
所有錯誤必須統一錯誤格式。

常見的狀態碼

• 1xx 代表請求已被接受，需要繼續處理 api中一般不出現
• 2xx 請求已成功，請求所希望的響應頭或數據體將隨此響應返回
  • 200 服務器成功返回用戶請求的數據
  • 201 用戶新建或修改數據成功
  • 202 表示一個請求已經進入后臺排隊（成功了沒有返回值，是一個異步）
  • 204 刪除成功
• 3xx 重定向
• 4xx 客戶端原因引起的錯誤
  • 404 請求的接口不存在，錯誤類型（請求地址錯了）
  • 401 用戶未登錄
  • 403 用戶登錄了，但是沒有權限訪問
  • 422 客戶端參數錯誤，驗證錯誤
  • 429 超出請求限制
• 5xx 服務端原因引起的錯誤
  • 500 服務器遇到了一個未曾預料的狀況，導致了它無法完成對請求的處理，服務端代碼報錯
  • 503 服務器維護之中
  • 504 超時調用

錯誤格式

'message' => ':message',          // 錯誤的具體描述 'errors' => ':errors',            // 參數的具體錯誤描述，422 等狀態提供 'code' => ':code',                // 業務自定義的異常碼 'status_code' => ':status_code',  // http狀態碼 'debug' => ':debug',              // debug 信息，非生產環境提供

什么是報文？

HTTP報文時是HTTP進行請求和響應時用來交換信息的。報文是由客戶端流入服務器的

報文分為兩類：請求報文，響應報文

請求和響應報文的基本報文結構相同，都是由三部分組成：

• 起始行：對報文進行描述
• 首部：一些屬性
• 主體：數據【可選】

axios

兼容瀏覽器和node服務器
從瀏覽器中創建 XMLHttpRequests
從 node.js 創建 http 請求

支持 Promise API
支持攔截請求和響應
轉換請求數據和響應數據
取消請求
自動轉換 JSON 數據
客戶端支持防御 XSRF

加油，陌生人! (來來往往不陌生，希望對您有所幫助)