什么是restful？

restful是當(dāng)下最流行的接口設(shè)計(jì)規(guī)范，前端和后端都必須知道的一種規(guī)范
該規(guī)范定義了接口開(kāi)發(fā)中，各個(gè)流程之中

協(xié)議

客戶端在通過(guò) API 與后端服務(wù)通信的過(guò)程中，應(yīng)該 使用 HTTPS 協(xié)議

域名

API 應(yīng)該部署在專用域名之下，應(yīng)盡可能保持足夠簡(jiǎn)單。如果確定 API 很簡(jiǎn)單，不會(huì)有進(jìn)一步擴(kuò)展，可以考慮放在主域名下，這里有兩個(gè)常見(jiàn)的 URL 根例子：

• api.example.com/* 單獨(dú)一個(gè)子域名用來(lái)訪問(wèn)接口
• example.com/api/* 主域名之下單獨(dú)一個(gè)空間

版本（Versioning）

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

地址（path） 路由（router）

API 的具體網(wǎng)址

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

至于 URL 是否必須使用連字符（-） 或下劃線（_），不做硬性規(guī)定，但 必須 根據(jù)團(tuán)隊(duì)情況統(tǒng)一一種風(fēng)格

• 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

動(dòng)詞（請(qǐng)求方法 method）

對(duì)于資源的具體操作類型，由 HTTP 動(dòng)詞表示。常用的 HTTP 動(dòng)詞有下面五個(gè)（括號(hào)里是對(duì)應(yīng)的 SQL 命令）。

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

url參數(shù)

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

響應(yīng)（Response）

必須 選擇合適的 HTTP 狀態(tài)碼。
必須 返回 JSON 格式數(shù)據(jù)。
所有錯(cuò)誤必須統(tǒng)一錯(cuò)誤格式。

常見(jiàn)的狀態(tài)碼

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

錯(cuò)誤格式

'message' => ':message',          // 錯(cuò)誤的具體描述 'errors' => ':errors',            // 參數(shù)的具體錯(cuò)誤描述，422 等狀態(tài)提供 'code' => ':code',                // 業(yè)務(wù)自定義的異常碼 'status_code' => ':status_code',  // http狀態(tài)碼 'debug' => ':debug',              // debug 信息，非生產(chǎn)環(huán)境提供

什么是報(bào)文？

HTTP報(bào)文時(shí)是HTTP進(jìn)行請(qǐng)求和響應(yīng)時(shí)用來(lái)交換信息的。報(bào)文是由客戶端流入服務(wù)器的

報(bào)文分為兩類：請(qǐng)求報(bào)文，響應(yīng)報(bào)文

請(qǐng)求和響應(yīng)報(bào)文的基本報(bào)文結(jié)構(gòu)相同，都是由三部分組成：

• 起始行：對(duì)報(bào)文進(jìn)行描述
• 首部：一些屬性
• 主體：數(shù)據(jù)【可選】

axios

兼容瀏覽器和node服務(wù)器
從瀏覽器中創(chuàng)建 XMLHttpRequests
從 node.js 創(chuàng)建 http 請(qǐng)求

支持 Promise API
支持?jǐn)r截請(qǐng)求和響應(yīng)
轉(zhuǎn)換請(qǐng)求數(shù)據(jù)和響應(yīng)數(shù)據(jù)
取消請(qǐng)求
自動(dòng)轉(zhuǎn)換 JSON 數(shù)據(jù)
客戶端支持防御 XSRF

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