如何設計出優美的Web API？

• 概述

WEB API的應用場景非常豐富，例如：將已有系統的功能或資料開放給合作伙伴或生態圈；對外發布可嵌入到其他網頁的微件；構建前後端分離的WEB應用；開發跨不同終端的移動應用；整合公司內部不同系統等等。在上述場景裡，你可能是WEB API的使用者，也可能是設計者，但你知道如何評判WEB API的優劣嗎？

• 評判標準

我們可以從三個維度來評判一個WEB API的優劣：

• 易於使用：WEB API的使用者是程式還是人？我覺得首先是人，然後是程式。為什麼這麼說呢？是否採用某個WEB API的決定是人做出的，一個好的WEB API必須符合人的審美，例如：簡短易記、通俗易懂、便於輸入等。從程式角度看，WEB API應該遵循行業規範，在呼叫時不需要做特殊化處理，有利於複用已有的程式碼或工具。
• 便於更改：一個WEB API釋出上線之後，免不了要根據真實使用者的反饋或者業務發展的需要做更新修改，這些更新修改必須儘量不影響使用者。要麼提供多版本支援，要麼給使用者提供切實可行的更新策略等等。
• 健壯穩定：對外公開的WEB API存在被攻擊的風險，以及無法準確預估的訪問量等，一個好的WEB API必須要有防注入、防篡改、防重放等安全機制，還要在訪問量急劇上漲時避免服務被擊穿。

做到了上述三個方面，我們才有底氣將一個WEB API對外開放，接受公眾的檢驗。好的WEB API不僅方便使用，還助於提升個人或企業的技術影響力，從而形成正向迴圈，帶來越來越多的業務價值。為了設計出優美的WEB API，我們需要了解與之相關的設計規範和事實標準，並且在設計開發過程中儘量遵循它們。

• 設計規範

URI

• 便於輸入的URI，簡短不冗餘。每個WEB API都是一個服務，那下面反例當中的“service”就是冗餘的，而且“api”也重複出現了兩次，這種冗餘都不利於記憶和輸入：

• 容易讀懂的URI，不要隨意採用縮寫，縮寫必須要符合國際標準規範，不要憑空發明創造，例如：國家程式碼定義（ISO3166）。反例中出現了兩處縮寫“sv”、“u”，在沒有附加說明的情況下，使用者壓根不知道含義：

• 沒有大小寫混用的URI。HTTP協議（RFC7230）規定：除了模式（schema）和主機名以外，URI的其他資訊都要區分字母的大小寫。下述兩個反例大小寫混用，不方便記憶。

• 易於修改的URI，命名存在可預見的規律。下述正例我們可以很容易猜測改變最後的ID就可以訪問其他商品的資訊。

• 不會暴露服務端架構的URI，URI只需要體現功能、資料結構和含義，無需暴露服務端如何運作的資訊。這些資訊對使用者來說沒有意義，還存在潛在的風險，惡意使用者或者駭客會利用這些資訊來尋找漏洞，發起對服務的攻擊。

• 規則統一的URI，確保採用統一的規則和風格，方便使用者記憶和使用。下述反例中第一個URI採用了查詢引數，第二個URI採用了路徑引數，這兩者沒有保持一致，容易造成混亂。

• URI最好由名片語成。URI的全稱是統一資源定位符（Uniform Resource Identifier），用於標識資源在網際網路上的位置，類似於郵寄地址，而地址都是由名片語成的。在名詞使用上也有一些需要注意的事項：其一，使用名詞複數形式；其二，儘量採用多數API中使用的表示相同含義的單詞；其三，透過儘可能少的單詞來表示；其四，儘可能不用奇怪的縮略語等。
• 不使用空格及需要編碼的字元，例如在URI中使用中文等。
• 使用連線符（-）來連線多個單詞，推薦脊柱法：首先，URI裡的主機名（域名）允許使用連字元而禁止使用下劃線，且不區分大小寫。其次，點字元具有特殊含義，為了與主機名的規則保持一致。

查詢引數

• 許多場景下需要透過API分批次獲取資料，我們會經常糾結采用什麼樣的查詢引數，業界有兩種常用的引數設計（per-page與page、limit與offset），用於標識每次獲取的資料量和起始位置。在分批次獲取資料的過程中，資料集合中的記錄可能發生增刪改變，我們需要注意採用相對位置或絕對位置所帶來的不同效果。

• 在設計過濾的引數時，業界也有一些事實標準可供參考。如果我們期望查詢結果的特定屬性取值跟過濾引數的取值完全相同，那過濾引數的名稱通常為屬性名；如果我們期望查詢結果任意屬性部分包含過濾引數的取值，那過濾引數的名稱通常為“q”。

• URI是否可以包含動詞“search”？通常以搜尋為主的線上服務API可以包含，除此之外建議採用名詞複數形式。常用英文單詞“search”和“find”都有查詢的含義，但兩者還是有一些細微的差別，其中“search”用於模糊搜尋，而“find”用於精準查詢。

• 某個屬性究竟是作為URI路徑的構成元素還是作為查詢引數呢？我們可以按照以下規則來判斷：如果該屬性資訊可以唯一定位資源，那麼它就適合作為路徑構成元素，否則就作為查詢引數；如果該屬性可以省略，那麼它就是適合作為查詢引數。

HTTP方法

按照HTTP協議設計的本意，URI用於標識被操作的目標物件（資源），而HTTP方法則是表示操作方法。基於HTTP協議的簡單物件訪問協議SOAP逐漸被RESTful的原生HTTP協議取代，我們也沒有必要畫蛇添足，最好就是吃透HTTP協議，充分利用它的特性。

• GET，獲取資源
• POST，新增資源
• PUT，更新已有資源
• DELETE，刪除資源
• PATCH，更新部分資源
• HEAD，獲取資源的元資訊

如果遇到上述HTTP方法無法覆蓋的場景，那通常是資源的設計粒度太大了，我們可以把粗粒度的資源分解成多個細粒度的資源。在使用HTTP協議設計WEB API的專業能力上，業界將其劃分為四個層級，LEVEL3相對較理想化，缺乏實施的基礎，LEVEL2是切實可行的：

• LEVEL 0：使用HTTP
• LEVEL 1：引入資源的概念
• LEVEL 2：引入HTTP動詞（GET/POST/PUT/DELETE等）
• LEVEL 3：引入HATEOAS概念

響應資料

常用的資料格式有：HTML、XML、JSON、YAML等，如果我們的服務在響應時支援不同型別的資料格式，那應用在呼叫服務時如何獲得期望格式的響應資料呢？通常我們可以考慮採用下述幾種指定資料格式的方法：

• 使用查詢引數的方法：

• 使用副檔名的方法：

• 使用在請求首部指定媒體型別的方法，優先推薦此種方法：

響應資料應該包含哪些資訊呢？是否越多越好？亦或越少越好，僅僅包含ID？建議是按需返回，根據業務功能所需返回相應的資料。如果一個WEB API需要提供給不同業務場景使用，不同業務場景對資料屬性資訊的要求不同，或多或少，這種情況我們可以讓使用者來選擇響應的內容，選擇方法就是透過查詢引數指定：

響應資料的結構應該儘量扁平化，不要巢狀太深，減少沒有具體含義的資訊載荷，這樣既可以壓縮報文尺寸，又可以節省頻寬的。當然，如果層級結構更具優勢，也可以採用。

出錯資訊

建議透過HTTP協議首部的狀態碼來表示出錯資訊，而不是再封裝一層，遵守協議規範的好處是可以減少溝通的成本，也可以利用許多成熟的軟硬體產品來處理異常出錯資訊。HTTP協議定了了五種型別的狀態碼：

• 1XX：訊息
• 2XX：成功
• 3XX：重定向
• 4XX：客戶端原因引起的錯誤
• 5XX：伺服器端原因引起的錯誤

我們需要每種狀態碼的使用場景，確保正確使用狀態碼。除此之外，服務還需要向客戶端返回詳細的出錯資訊，我們通常可以採用下述兩種方法來傳遞詳細的出錯資訊：

• 方法1：定義私有的首部，將其填入響應訊息的首部。
• 方法2：將詳細的出錯資訊放入訊息體。

版本管理

隨著業務的發展，每個釋出上線的WEB API都存在更新修改的可能，那就需要引入版本管理的機制。業界有三種常見的標註WEB API版本的方法：

• 在URI中嵌入版本編號：

• 在查詢字串里加入版本資訊：

• 透過媒體型別來指定版本資訊

同樣，版本編號也存在業界規範：語義化版本控制（Semantic Versioning）規範，網站地址： 。版本編號由點號連線的3個數字組成，例如：1.2.3，分別表示主版本編號、次版本編號、補丁版本編號，版本編號的增加遵循下述規則：

• 在對軟體進行不向下相容的變更時，增加主版本編號；
• 在對軟體進行向下相容的變更或廢除某些特定的功能時，增加次版本編號；
• 如果軟體的API沒有發生變更，只是修正了部分bug，則增加補丁版本編號。

按照版本編號增長的規則，WEB API的版本編號只需要標註主版本編號就可以了，因為次版本編號、補丁版本編號的增加都可以做到向下相容，不會影響使用者使用，唯有主版本編號增加才需要使用者更新升級。除了標註版本資訊之外，我們在對外發布WEB API時還需要設計好版本變更的策略，例如：老版本提供多久的過渡期、同時相容多少個版本、特定版本的終止日期等等。

• 總結

何為優美？就是符合大眾審美的，對於WEB API來說，就是符合標準規範的，這有利於降低使用者學習和使用的成本，便於交流，不存在隱沒成本。通常，業界存在的標準規範和事實標準都是經過實踐篩選出來的，從遵循模仿開始，然後再找機會創新，而不是一上來就重複發明輪子。

WEB API設計領域的標準規範就是URI、HTTP等，我們要最大程度地利用這些協議規範，讓每個WEB API都是使用者友好（易於使用）、技術友好（支援快取、易於更改）的。除此之外，我們還需要考慮WEB API的健壯性，下一次我們再來談一談如何設計健壯的WEB API，歡迎大家找我討論交流相關話題。

原創不易，如果你覺得有價值，麻煩動動手指點個 「  贊 」，老兵哥會更有動力。另外，我還會持續分享職業規劃、應聘面試、技能提升、影響力打造等經驗，  關注  「    」，  賦能程式人生 ！