RESTFUL是一種網(wǎng)絡(luò)應(yīng)用程序的設(shè)計風(fēng)格和開發(fā)方式，基于HTTP，可以使用XML格式定義或JSON格式定義。

1.RESTful風(fēng)格API

? 詳情查看博客地址：http://www.rzrgm.cn/xiaonq/p/10053234.html

---

1.1 什么是RESTful

• REST與技術(shù)無關(guān)，代表的是一種軟件架構(gòu)風(fēng)格（REST是Representational State Transfer的簡稱，中 文翻譯為“表征狀態(tài)轉(zhuǎn)移”）

• REST從資源的角度類審視整個網(wǎng)絡(luò)，它將分布在網(wǎng)絡(luò)中某個節(jié)點的資源通過URL進行標識

• 所有的數(shù)據(jù)，不過是通過網(wǎng)絡(luò)獲取的還是操作（增刪改查）的數(shù)據(jù)，都是資源，將一切數(shù)據(jù)視為資 源是REST區(qū)別與其他架構(gòu)風(fēng)格的最本質(zhì)屬性

• 對于REST這種面向資源的架構(gòu)風(fēng)格，有人提出一種全新的結(jié)構(gòu)理念，即：面向資源架構(gòu)（ROA： Resource Oriented Architecture）

  1.2web開發(fā)本質(zhì)

• 對數(shù)據(jù)庫中的表進行增刪改查操作

• Restful風(fēng)格就是把所有數(shù)據(jù)都當(dāng)做資源，對表的操作就是對資源操作

• 在url同通過 資源名稱來指定資源

• 通過 get/post/put/delete/patch 對資源的操作

2.RESTful API設(shè)計規(guī)范

• 1.API與用戶的通信協(xié)議，總是使用HTTPs協(xié)議。

• 2.域名

  # 1）子域名方式 
  	https://api.example.com 			盡量將API部署在專用域名（會存在跨 域問題）		
        https://www.example.com 
   #2）url方式 
        https://example.org 
        https://example.org/api/			API很簡單
  

• 3.版本

  URL，如：https://api.example.com/v1/ 
  # 請求頭 跨域時，引發(fā)發(fā)送多次請求
  

• 4.面向資源編程 ： 路徑，視網(wǎng)絡(luò)上任何東西都是資源，均使用名詞表示（可復(fù)數(shù)）

  https://api.example.com/v1/zoos 
  https://api.example.com/v1/animals 
  https://api.example.com/v1/employees
  

• 5.method

  GET（查詢數(shù)據(jù)） # 從服務(wù)器取出資源（一項或多項） 
  POST（創(chuàng)建數(shù)據(jù)） # 在服務(wù)器新建一個資源 
  PUT（修改數(shù)據(jù)） # 在服務(wù)器更新資源（客戶端提供改變后的完整資源） 
  PATCH（修改屬性） # 在服務(wù)器更新資源（客戶端提供改變的屬性） 
  DELETE（刪除數(shù)據(jù)） # 從服務(wù)器刪除資源
  

• 6.過濾，分頁，排序 ：通過在url上傳參的形式傳遞搜索條件

  https://api.example.com/v1/zoos?limit=10：指定返回記錄的數(shù)量 
  https://api.example.com/v1/zoos?offset=10：指定返回記錄的開始位置 
  https://api.example.com/v1/zoos?page=2&per_page=100：指定第幾頁，以及每頁的記錄數(shù) 
  https://api.example.com/v1/zoos?sortby=name&order=asc：指定返回結(jié)果按照哪個屬性排序， 以及排序順序 
  https://api.example.com/v1/zoos?animal_type_id=1：指定篩選條件
  

• 7.狀態(tài)碼

  '''1. 2XX請求成功''' 
  # 200 請求成功，一般用于GET與POST請求 
  # 201 Created - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功。 
  # 202 Accepted - [*]：表示一個請求已經(jīng)進入后臺排隊（異步任務(wù)） 
  # 204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。 
  
  '''2. 3XX重定向''' 
  # 301 NO CONTENT - 永久重定向 
  # 302 NO CONTENT - 臨時重定向 
  
  '''3. 4XX客戶端錯誤''' 
  # 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請求有錯誤。 
  # 401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌、用戶名、密碼錯誤）。 
  # 403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯誤相對），但是訪問是被禁止的。
  # 404 NOT FOUND - [*]：用戶發(fā)出的請求針對的是不存在的記錄。
  # 406 Not Acceptable - [GET]：用戶請求的格式不可得（比如用戶請求JSON格式，但是只有XML格 式）。
  # 410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的。 
  # 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個對象時，發(fā)生一個驗證錯誤。 '''4. 5XX服務(wù)端錯誤''' 
  
  # 500 INTERNAL SERVER ERROR - [*]：服務(wù)器內(nèi)部錯誤，無法完成請求 
  # 501 Not Implemented 服務(wù)器不支持請求的功能，無法完成請求 
  
  更多狀態(tài)碼參考：https://www.runoob.com/http/http-status-codes.html