一、協定
API與使用者的通信協定，總是使用HTTPs協定。
二、域名
應該盡量将API部署在專用域名之下。
https://api.example.com
如果确定API很簡單，不會有進一步擴充，可以考慮放在主域名下。
https://example.org/api/
三、版本（Versioning）
應該将API的版本号放入URL。
https://api.example.com/v1/
另一種做法是，将版本号放在HTTP頭資訊中，但不如放入URL友善和直覺。Github采用這種做法。
四、路徑（Endpoint）
路徑又稱"終點"（endpoint），表示API的具體網址。
在RESTful架構中，每個網址代表一種資源（resource），是以網址中不能有動詞，隻能有名詞，而且所用的名詞往往與資料庫的表格名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），是以API中的名詞也應該使用複數。
舉例來說，有一個API提供動物園（zoo）的資訊，還包括各種動物和雇員的資訊，則它的路徑應該設計成下面這樣。
- https://api.example.com/v1/zoos
- https://api.example.com/v1/animals
- https://api.example.com/v1/employees
五、HTTP動詞
對于資源的具體操作類型，由HTTP動詞表示。
常用的HTTP動詞有下面五個（括号裡是對應的SQL指令）。
- GET（SELECT）：從伺服器取出資源（一項或多項）。
- POST（CREATE）：在伺服器建立一個資源。
- PUT（UPDATE）：在伺服器更新資源（用戶端提供改變後的完整資源）。
- PATCH（UPDATE）：在伺服器更新資源（用戶端提供改變的屬性）。
- DELETE（DELETE）：從伺服器删除資源。
還有兩個不常用的HTTP動詞。
- HEAD：擷取資源的中繼資料。
- OPTIONS：擷取資訊，關于資源的哪些屬性是用戶端可以改變的。
下面是一些例子。
- GET /zoos：列出所有動物園
- POST /zoos：建立一個動物園
- GET /zoos/ID：擷取某個指定動物園的資訊
- PUT /zoos/ID：更新某個指定動物園的資訊（提供該動物園的全部資訊）
- PATCH /zoos/ID：更新某個指定動物園的資訊（提供該動物園的部分資訊）
- DELETE /zoos/ID：删除某個動物園
- GET /zoos/ID/animals：列出某個指定動物園的所有動物
- DELETE /zoos/ID/animals/ID：删除某個指定動物園的指定動物
六、過濾資訊（Filtering）
如果記錄數量很多，伺服器不可能都将它們傳回給使用者。API應該提供參數，過濾傳回結果。
下面是一些常見的參數。
- ?limit=10：指定傳回記錄的數量
- ?offset=10：指定傳回記錄的開始位置。
- ?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
- ?sortby=name&order=asc：指定傳回結果按照哪個屬性排序，以及排序順序。
- ?animal_type_id=1：指定篩選條件
參數的設計允許存在備援，即允許API路徑和URL參數偶爾有重複。比如，GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
七、狀态碼（Status Codes）
伺服器向使用者傳回的狀态碼和提示資訊，常見的有以下一些（方括号中是該狀态碼對應的HTTP動詞）。
- 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 - [*]：伺服器發生錯誤，使用者将無法判斷發出的請求是否成功。
狀态碼的完全清單參見這裡。
八、錯誤處理（Error handling）
如果狀态碼是4xx，就應該向使用者傳回出錯資訊。一般來說，傳回的資訊中将error作為鍵名，出錯資訊作為鍵值即可。
{ error: "Invalid API key" }
九、傳回結果
針對不同操作，伺服器向使用者傳回的結果應該符合以下規範。
- GET /collection：傳回資源對象的清單（數組）
- GET /collection/resource：傳回單個資源對象
- POST /collection：傳回新生成的資源對象
- PUT /collection/resource：傳回完整的資源對象
- PATCH /collection/resource：傳回完整的資源對象
- DELETE /collection/resource：傳回一個空文檔
十、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" }
上面代碼表示，伺服器給出了提示資訊，以及文檔的網址。
十一、其他
（1）API的身份認證應該使用OAuth 2.0架構。
（2）伺服器傳回的資料格式，應該盡量使用JSON，避免使用XML。
原文：http://www.ruanyifeng.com/blog/2014/05/restful_api.html