前言

網(wǎng)絡(luò)應(yīng)用程序制肮，分為前端和后端兩個(gè)部分冒窍。當(dāng)前的發(fā)展趨勢(shì)，就是前端設(shè)備層出不窮（手機(jī)豺鼻、平板综液、桌面電腦、其他專用設(shè)備......）儒飒。因此谬莹，必須有一種統(tǒng)一的機(jī)制，方便不同的前端設(shè)備與后端進(jìn)行通信桩了。這導(dǎo)致API構(gòu)架的流行届良，甚至出現(xiàn)"API First"的設(shè)計(jì)思想。RESTful API是目前比較成熟的一套互聯(lián)網(wǎng)應(yīng)用程序的API設(shè)計(jì)理論圣猎。

資源 （Resources）

URI (Uniform Resource Identifiers) 統(tǒng)一資源標(biāo)示符

URI = scheme "://" authority "/" path [ "?" query ] [ "#" fragment ]

URI規(guī)范

URI不包含動(dòng)詞士葫，使用名詞復(fù)數(shù)。
URI不使用大寫送悔。
URI層級(jí)不要太深慢显。
URL(Uniform Resource Locator) 統(tǒng)一資源定位符(URI的實(shí)現(xiàn))

表現(xiàn)（Representation）

HTTP請(qǐng)求的頭信息中，用Accept和Content-Type標(biāo)示欠啤。

HTTP動(dòng)詞

對(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ù)器刪除資源除嘹。

還有兩個(gè)不常用的HTTP動(dòng)詞。

• HEAD：獲取資源的元數(shù)據(jù)岸蜗。
• OPTIONS：獲取信息尉咕，關(guān)于資源的哪些屬性是客戶端可以改變的。

Restful api 一些例子:

• GET /zoos：列出所有動(dòng)物園
• POST /zoos：新建一個(gè)動(dòng)物園
• GET /zoos/ID：獲取某個(gè)指定動(dòng)物園的信息
• PUT /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的全部信息）
• PATCH /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的部分信息）
• DELETE /zoos/ID：刪除某個(gè)動(dòng)物園
• GET /zoos/ID/animals：列出某個(gè)指定動(dòng)物園的所有動(dòng)物
• DELETE /zoos/ID/animals/ID：刪除某個(gè)指定動(dòng)物園的指定動(dòng)物
  過(guò)濾信息

如果記錄數(shù)量很多璃岳，服務(wù)器不可能都將它們返回給用戶年缎。API應(yīng)該提供參數(shù)，過(guò)濾返回結(jié)果铃慷。下面是一些常見的參數(shù)单芜。

• ?limit=10：指定返回記錄的數(shù)量
• ?offset=10：指定返回記錄的開始位置。
• ?page=2&per_page=100：指定第幾頁(yè)犁柜，以及每頁(yè)的記錄數(shù)洲鸠。
• ?sortby=name&order=asc：指定返回結(jié)果按照哪個(gè)屬性排序，以及排序順序赁温。
• ?animal_type_id=1：指定篩選條件

參數(shù)的設(shè)計(jì)允許存在冗余坛怪，即允許API路徑和URL參數(shù)偶爾有重復(fù)。比如股囊，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的袜匿。

常見異常返回碼

• 200 OK - [GET]：服務(wù)器成功返回用戶請(qǐng)求的數(shù)據(jù)，該操作是冪等的（Idempotent）稚疹。
• 201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功居灯。
• 202 Accepted - [*]：表示一個(gè)請(qǐng)求已經(jīng)進(jìn)入后臺(tái)排隊(duì)（異步任務(wù)）
• 204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。
• 400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請(qǐng)求有錯(cuò)誤内狗，服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作怪嫌，該操作是冪等的。
• 401 Unauthorized - [*]：表示用戶沒有權(quán)限（令牌柳沙、用戶名岩灭、密碼錯(cuò)誤）。
• 403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)）赂鲤，但是訪問是被禁止的噪径。
• 404 NOT FOUND - [*]：用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄，服務(wù)器沒有進(jìn)行操作数初，該操作是冪等的找爱。
• 406 Not Acceptable - [GET]：用戶請(qǐng)求的格式不可得（比如用戶請(qǐng)求JSON格式，但是只有XML格式）泡孩。
• 410 Gone -[GET]：用戶請(qǐng)求的資源被永久刪除车摄，且不會(huì)再得到的。
• 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對(duì)象時(shí)，發(fā)生一個(gè)驗(yàn)證錯(cuò)誤吮播。
  -500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯(cuò)誤变屁，用戶將無(wú)法判斷發(fā)出的請(qǐng)求是否成功。

異步任務(wù)

由于互聯(lián)網(wǎng)通信 高延時(shí)（high latency）薄料、高并發(fā)等特點(diǎn) 異步任務(wù)派上大用場(chǎng)敞贡。

• 先返回任務(wù)創(chuàng)建成功
• 客戶端輪詢?nèi)蝿?wù)狀態(tài)