RESTful風格API

---

RESTful風格API

---

詳情檢視部落格地址

1 什麼是 RESTful

• REST與技術無關，代表的是一種軟體架構風格（REST是Representational State Transfer的簡稱，中 文翻譯為“表徵狀態轉移”）

• REST從資源的角度類審視整個網路，它將分佈在網路中某個節點的資源通過URL進行標識

• 所有的資料，不過是通過網路獲取的還是操作（增刪改查）的資料，都是資源，將一切資料視為資 源是REST區別與其他架構風格的最本質屬性

• 對於REST這種面向資源的架構風格，有人提出一種全新的結構理念，即：面向資源架構（ROA： Resource Oriented Architecture）

1.2 web開發本質

- 對資料庫中的表進行增刪改查操作
- Restful風格就是把所有資料都當做資源，對錶的操作就是對資源操作 
- 在url同通過 資源名稱來指定資源 
- 通過 get/post/put/delete/patch 對資源的操作

---

2. RESTful API設計規範

- 1.API與使用者的通訊協議，總是使用HTTPs協議。
- 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/

請求頭 跨域時，引發傳送多次請求

• 4.面向資源程式設計 ： 路徑，視網路上任何東西都是資源，均使用名詞表示（可複數）

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

- 5.method

GET（查詢資料） # 從伺服器取出資源（一項或多項）
POST（建立資料） # 在伺服器新建一個資源
PUT（修改資料） # 在伺服器更新資源（客戶端提供改變後的完整資源）
PATCH（修改屬性） # 在伺服器更新資源（客戶端提供改變的屬性）
DELETE（刪除資料） # 從伺服器刪除資源

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

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

- 7.狀態碼

'''1. 2XX請求成功'''
# 200 請求成功，一般用於GET與POST請求
# 201 Created - [POST/PUT/PATCH]：使用者新建或修改資料成功。
# 202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）
# 204 NO CONTENT - [DELETE]：使用者刪除資料成功。
'''2. 3XX重定向'''
# 301 NO CONTENT - 永久重定向
# 302 NO CONTENT - 臨時重定向
'''3. 4XX客戶端錯誤'''
# 400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤。
# 401 Unauthorized - [*]：表示使用者沒有許可權（令牌、使用者名稱、密碼錯誤）。
# 403 Forbidden - [*] 表示使用者得到授權（與401錯誤相對），但是訪問是被禁止的。
# 404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄。
# 406 Not Acceptable - [GET]：使用者請求的格式不可得（比如使用者請求JSON格式，但是隻有XML格
式）。
# 410 Gone -[GET]：使用者請求的資源被永久刪除，且不會再得到的。
# 422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時，發生一個驗證錯誤。
'''4. 5XX服務端錯誤'''
# 500 INTERNAL SERVER ERROR - [*]：伺服器內部錯誤，無法完成請求
# 501 Not Implemented 伺服器不支援請求的功能，無法完成請求

更多狀態碼參考: 點我!!