Restful API設計思路
Restful API是目前比較成熟的一套網際網路應用程式的API設計理念，Rest是一組架構約束條件和原則，如何Rest約束條件和原則的架構，我們就稱為Restful架構，Restful架構具有結構清晰、符合標準、易於理解以及擴充套件方便等特點，受到越來越多網站的採用！
Restful API介面規範包括以下部分：
一、協議
API與使用者的通訊協議，總是使用HTTPs協議。
二、域名
應該儘量將API部署在專用域名之下，如https://api.oldboyedu.com；如果確定API很簡單，不會有進一步擴充套件，可以考慮放在主域名下，如https://oldboyedu.com/api/。
三、版本
可以將版本號放在HTTP頭資訊中，也可以放入URL中，如https://api.oldboyedu.com/v1/
四、路徑
路徑是一種地址，在網際網路上表現為網址，在RESTful架構中，每個網址代表一種資源（resource），所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的表格名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以API中的名詞也應該使用複數，如https://api.oldboyedu.com/v1/students。
五、HTTP動詞
對於資源的具體操作型別，由HTTP動詞表示，HTTP動詞主要有以下幾種，括號中對應的是SQL命令。
1. GET（SELECT）：從伺服器取出資源（一項或多項）；
2. POST（CREATE）：在伺服器新建一個資源；
3. PUT（UPDATE）：在伺服器更新資源（客戶端提供改變後的完整資源）；
4. PATCH（UPDATE）：在伺服器更新資源（客戶端提供改變的屬性）；
5. DELETE（DELETE）：從伺服器刪除資源；
6. HEAD：獲取資源的元資料；
7. OPTIONS：獲取資訊，關於資源的哪些屬性是客戶端可以改變的。
六、過濾資訊
如果記錄數量很多，伺服器不可能都將它們返回給使用者，API會提供引數，過濾返回結果，常見的引數有：
1. ?limit=20：指定返回記錄的數量為20；
2. ?offset=8：指定返回記錄的開始位置為8；
3. ?page=1&per_page=50：指定第1頁，以及每頁的記錄數為50；
4. ?sortby=name&order=asc：指定返回結果按照name屬性進行升序排序；
5. ?animal_type_id=2：指定篩選條件。
七、狀態碼
伺服器會向用戶返回狀態碼和提示資訊，以下是常用的一些狀態碼：
1. 200 OK - [GET]：伺服器成功返回使用者請求的資料；
2. 201 CREATED - [POST/PUT/PATCH]：使用者新建或修改資料成功；
3. 202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）；
4. 204 NO CONTENT - [DELETE]：使用者刪除資料成功；
5. 400 INVALID REQUEST - [POST/PUT/PATCH]：使用者發出的請求有錯誤，伺服器沒有進行新建或修改資料的操作；
6. 401 Unauthorized - [*]：表示使用者沒有許可權（令牌、使用者名稱、密碼錯誤）；
7. 403 Forbidden - [*] 表示使用者得到授權（與401錯誤相對），但是訪問是被禁止的；
8. 404 NOT FOUND - [*]：使用者發出的請求針對的是不存在的記錄，伺服器沒有進行操作；
9. 406 Not Acceptable - [GET]：使用者請求的格式不可得；
10. 410 Gone -[GET]：使用者請求的資源被永久刪除，且不會再得到的；
11. 422 Unprocesable entity - [POST/PUT/PATCH] 當建立一個物件時，發生一個驗證錯誤；
12. 500 INTERNAL SERVER ERROR - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。
八、錯誤處理
如果狀態碼是4xx，就會向用戶返回出錯資訊，一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值。
九、返回結果
針對不同操作，伺服器向用戶返回的結果應該符合以下規範：
1. GET /collection：返回資源物件的列表（陣列）；
2. GET /collection/resource：返回單個資源物件；
3. POST /collection：返回新生成的資源物件；
4. PUT /collection/resource：返回完整的資源物件；
5. PATCH /collection/resource：返回完整的資源物件；
6. DELETE /collection/resource：返回一個空文件。
十、Hypermedia API
RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼。
以上是Restful API設計應遵循的十大規範，除此之外，Restful API還需注意身份認證應該使用OAuth 2.0框架，伺服器返回的資料格式，應該儘量使用JSON，避免使用XML。