WEB開發面面談之（4）——RESTful API 設計指南

lsxiao 發布于2019-08-22 18:35 / 933人閱讀

摘要：指定返回記錄的數量。狀態碼服務器向用戶返回的狀態碼和提示信息，常見的有以下一些方括號中是該狀態碼對應的動詞。返回結果針對不同操作，服務器向用戶返回的結果應該符合以下規范。

>>>點擊獲取更多文章<<<

網絡應用程序，分為前端和后端兩個部分。當前的發展趨勢，就是前端設備層出不窮（手機、平板、桌面電腦、其他專用設備......）。

因此，必須有一種統一的機制，方便不同的前端設備與后端進行通信。這導致API構架的流行，甚至出現"API First"的設計思想。RESTful API是目前比較成熟的一套互聯網應用程序的API設計理論。

協議

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/an...

https://api.example.com/v1/em...

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。

文章轉自阮一峰的 RESTful API 設計指南,適當精簡少部分語句

云服務器 GPU云服務器亞馬遜api開發者指南 HTML5移動Web開發指南 restful_api返回 web前端開發設計師

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/96016.html

設計架構

摘要：先來看一張系統前后端架構模型圖。一種接口的約定本文用于定義一種統一的接口設計方案，希望具有參考價值。，和都是常見的軟件架構設計模式，它通過分離關注點來改進代碼的組織方式。如何無痛降低 if else 面條代碼復雜度相信不少同學在維護老項目時，都遇到過在深深的 if else 之間糾纏的業務邏輯。面對這樣的一團亂麻，簡單粗暴地繼續增量修改常常只會讓復雜度越來越高，可讀性越來越差，有沒...

graf 2019-06-24 17:56 評論0 收藏0
PHP / Laravel API 開發推薦閱讀清單

showImg(https://segmentfault.com/img/bV6aHV?w=1280&h=800); 社區優秀文章 Laravel 5.5+passport 放棄 dingo 開發 API 實戰，讓 API 開發更省心 - 自造車輪。 API 文檔神器 Swagger 介紹及在 PHP 項目中使用 - API 文檔撰寫方案推薦 Laravel API 項目必須使用的 8 個...

shmily 2019-06-28 18:34 評論0 收藏0
Java經典

摘要：請注意，我們在聊聊單元測試遇到問題多思考多查閱多驗證，方能有所得，再勤快點樂于分享，才能寫出好文章。單元測試是指對軟件中的最小可測試單元進行檢查和驗證。 JAVA容器-自問自答學HashMap 這次我和大家一起學習HashMap，HashMap我們在工作中經常會使用，而且面試中也很頻繁會問到，因為它里面蘊含著很多知識點，可以很好的考察個人基礎。但一個這么重要的東西，我為什么沒有在一開始...

xcold 2019-08-16 10:59 評論0 收藏0
Spring 指南（目錄）

摘要：指南無論你正在構建什么，這些指南都旨在讓你盡快提高工作效率使用團隊推薦的最新項目版本和技術。使用進行消息傳遞了解如何將用作消息代理。安全架構的主題指南，這些位如何組合以及它們如何與交互。使用的主題指南以及如何為應用程序創建容器鏡像。 Spring 指南無論你正在構建什么，這些指南都旨在讓你盡快提高工作效率 — 使用Spring團隊推薦的最新Spring項目版本和技術。入門指南這些...

only_do 2019-08-16 14:39 評論0 收藏0
后端API從入門到放棄指北

摘要：菜鳥教程框架中文手冊入門目標使用搭建通過對數據增刪查改沒了純粹占行用的拜后端API入門學習指北了解一下一下概念. RESTful API標準] 所有的API都遵循[RESTful API標準]. 建議大家都簡單了解一下HTTP協議和RESTful API相關資料. 阮一峰:理解RESTful架構阮一峰:RESTful API 設計指南 RESTful API指南依賴注入 D...

Jeffrrey 2019-08-16 12:31 評論0 收藏0