經常掛在嘴邊的restful,你對它真的掌握了嗎?

在平時開發中咱們可能採用的習慣一般爲如下方式：

        一、查詢使用GET請求、添加數據POST(這點是沒錯的)可是刪除數據和更新數據呢?又是怎麼在用呢?一般不少小夥伴都是GET用於刪除、POST用於更新
        二、既然咱們都是用GET作查詢和刪除、添加或更新用POST，那怎麼區分它們呢?廣大的小夥伴通常都是這樣的一下狀況：

查詢URL：***/find****或者 ***/get**** 等等相似方式
     添加URL：***/add****或者 ***/save**** 等等相似方式
     添加URL：***/update****等相似方式
     刪除URL: ***/delete****或者 ***/del**** 等等相似方式

可是以上的方式,設計得真的合理麼?（原來我以爲很合理,這樣簡單、易懂、通俗）

在RESTful架構中:

        （1）每個URI表明一種資源；因此網址中不能有動詞，只能有名詞，並且所用的名詞每每與數據庫的表格名對應。通常來講，數據庫中的表都是同種記錄的"集合"（collection），因此API中的名詞也應該使用複數。
        （2）客戶端和服務器之間，傳遞這種資源的某種表現層；
        （3）客戶端經過四個HTTP動詞，對服務器端資源進行操做，實現"表現層狀態轉化"。
所以以上的設計是否是立馬感受到，唉，這是什麼玩意呢? 名詞+動詞這徹底就不是restful設計啊

下邊介紹一下restful設計，對它有一個從新的認識

1、協議

API與用戶的通訊協議，老是使用HTTPS協議。

2、域名

應該儘可能將API部署在專用域名之下。 https://api.example.com 若是肯定API很簡單，不會有進一步擴展，能夠考慮放在主域名下。 https://example.org/api/

3、版本（Versioning）

應該將API的版本號放入URL。 https://api.example.com/v1/ 另外一種作法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。

4、路徑（Endpoint）

路徑又稱"終點"（endpoint），表示API的具體網址。 在RESTful架構中，每一個網址表明一種資源（resource），因此網址中不能有動詞，只能有名詞，並且所用的名詞每每與數據庫的表格名對應。通常來講，數據庫中的表都是同種記錄的"集合"（collection），因此API中的名詞也應該使用複數。

舉例來講，有一個API提供學校（school）的信息，還包括各類學校和學生的信息，則它的路徑應該設計成下面這樣。

`https://api.example.com/v1/schools`
    `https://api.example.com/v1/students`

5、HTTP動詞

對於資源的具體操做類型，由HTTP動詞表示。

經常使用的HTTP動詞有下面五個（括號裏是對應的SQL命令）。

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

還有兩個不經常使用的HTTP動詞。

HEAD：獲取資源的元數據。
        OPTIONS：獲取信息，關於資源的哪些屬性是客戶端能夠改變的。

下面是一些例子。

GET /schools：列出全部學校
        POST /schools：新建一個學校
        GET /schools/ID：獲取某個指定學校的信息
        PUT /schools/ID：更新某個指定學校的信息（提供該學校的所有信息）
        PATCH /schools/ID：更新某個指定學校的信息（提供該學校的部分信息）
        DELETE /schools/ID：刪除某個學校
        GET /schools/ID/students：列出某個指定學校的全部學生
        DELETE /zoos/ID/students/ID：刪除某個學校的指定學生

6、過濾信息（Filtering）

若是記錄數量不少，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。

下面是一些常見的參數。

?limit=10：指定返回記錄的數量
        ?offset=10：指定返回記錄的開始位置。
        ?sortby=name&order=asc：指定返回結果按照哪一個屬性排序，以及排序順序。
        ?schools_type_id=1：指定篩選條件

參數的設計容許存在冗餘，即容許API路徑和URL參數偶爾有重複。好比，GET /school/ID/students/ID 與 GET /students?student_id=ID 的含義是相同的。

7、狀態碼（Status Codes）

服務器向用戶返回的狀態碼和提示信息，常見的有如下一些（方括號中是該狀態碼對應的HTTP動詞）。

200 OK - [GET]：服務器成功返回用戶請求的數據，該操做是冪等的（Idempotent）。
        201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
        204 NO CONTENT - [DELETE]：用戶刪除數據成功。
        400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發出的請求有錯誤，服務器沒有進行新建或修改數據的操做，該操做是冪等的。。
        404 NOT FOUND - [*]：用戶發出的請求針對的是不存在的記錄，服務器沒有進行操做，該操做是冪等的。
        500 INTERNAL SERVER ERROR - [*]：服務器發生錯誤，用戶將沒法判斷髮出的請求是否成功。

狀態碼的徹底列表參見這裏。

8、錯誤處理（Error handling）

若是狀態碼是4xx，就應該向用戶返回出錯信息。通常來講，返回的信息中將error做爲鍵名，出錯信息做爲鍵值便可。

{
    error: "Invalid API key"
}

9、返回結果

針對不一樣操做，服務器向用戶返回的結果應該符合如下規範。

GET /collection：返回資源對象的列表（數組）
        GET /collection/resource：返回單個資源對象
        POST /collection：返回新生成的資源對象
        PUT /collection/resource：返回完整的資源對象
        PATCH /collection/resource：返回完整的資源對象
        DELETE /collection/resource：返回一個空文檔

10、Hypermedia API

RESTful API最好作到Hypermedia，即返回結果中提供連接，連向其餘API方法，使得用戶不查文檔，也知道下一步應該作什麼。

好比，當用戶向api.example.com的根目錄發出請求，會獲得這樣一個文檔。

{
    "link": {
                "rel":"collection https://www.example.com/zoos", 
                "href":  "https://api.example.com/zoos",
                "title": "List of zoos",
                "type":  "application/vnd.yourformat+json"
            }
}

上面代碼表示，文檔中有一個link屬性，用戶讀取這個屬性就知道下一步該調用什麼API了。rel表示這個API與當前網址的關係（collection關係，並給出該collection的網址），href表示API的路徑，title表示API的標題，type表示返回類型。

Hypermedia API的設計被稱爲HATEOAS。Github的API就是這種設計，訪問api.github.com會獲得一個全部可用API的網址列表。

{
    "current_user_url": "https://api.github.com/user",
    "authorizations_url": "https://api.github.com/authorizations",   
    // ... 
}

從上面能夠看到，若是想獲取當前用戶的信息，應該去訪問api.github.com/user，而後就獲得了下面結果。

{
    "message": "Requires authentication", 
    "documentation_url": "https://developer.github.com/v3"
}

上面代碼表示，服務器給出了提示信息，以及文檔的網址。