RESTful API

什麼是RESTful API ?

REST與技術無關，代表的是一種軟件架構風格，REST是Representational State Transfer的簡稱，中文翻譯爲“表徵狀態轉移”或“表現層狀態轉化”。

什麼是URI和URL?

URI統一的資源標誌符
URL統一的資源定位符
URI是給我們的資源進行標識的，URL是描述我們資源地址的。

REST風格的特點:

1. 在web中,只要有被引用的必要都叫資源.

2.每個URI代表一個資源,獨一無二的.

3. 客戶端通過HTTP的方法,對服務器端的資源進行操作.

4. 客戶端和服務器之間,傳遞這種資源的某種表層.

5. 通過超鏈接的指引,實現"表現層轉態轉移".

RESTFUL規範

面向資源編程

每個URL代表一種資源,URL中儘量不要用動詞,要用名詞.

根據methond不同,進行不同的操作

GET  : 從一個服務器取出資源(一項或多項)
POST : 從一個服務器新建一個資源
PUT ：在服務器更新資源（客戶端提供改變後的完整資源）
PATCH ：在服務器更新資源（客戶端提供改變的屬性）
DELETE ：從服務器刪除資源

過濾

通過在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：指定篩選條件

狀態碼

200 OK - [GET]：服務器成功返回用戶請求的數據，該操作是冪等的（Idempotent）。
201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
202 Accepted - [*]：表示一個請求已經進入後臺排隊（異步任務）
204 NO CONTENT - [DELETE]：用戶刪除數據成功。
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] 當創建一個對象時，發生一個驗證錯誤。
500 INTERNAL SERVER ERROR - [*]：服務器發生錯誤，用戶將無法判斷髮出的請求是否成功。

錯誤處理

狀態碼是4xx時，應返回錯誤信息，error當做key。

{
    error: "Invalid API key"
}

Hypermedia API

如果遇到需要跳轉的情況 攜帶調轉接口的URL

　ret = {
                code: 1000,
                data:{
                    id:1,
                    name:'小強',
                    depart_id:https://www.4399.com
                }
            }