RESTful API 設計指南

日期： 2023年5月22日

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

因此，必須有一種統一的機制，方便不同的前端裝置與後端進行通訊。這導致api構架的流行，甚至出現"api first"的設計思想。restful api是目前比較成熟的一套網際網路應用程式的api設計理論。我以前寫過一篇《理解restful架構》，**如何理解這個概念。

今天，我將介紹restful api的設計細節，**如何設計一套合理、好用的api。我的主要參考了兩篇文章（1，2）。

api與使用者的通訊協議，總是使用https協議。

應該盡量將api部署在專用網域名稱之下。

如果確定api很簡單，不會有進一步擴充套件，可以考慮放在主網域名稱下。

應該將api的版本號放入url。

/v1/

另一種做法是，將版本號放在http頭資訊中，但不如放入url方便和直觀。github採用這種做法。

路徑又稱"終點"（endpoint），表示api的具體**。

在restful架構中，每個**代表一種資源（resource），所以**中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的**名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以api中的名詞也應該使用複數。

舉例來說，有乙個api提供動物園（zoo）的資訊，還包括各種動物和雇員的資訊，則它的路徑應該設計成下面這樣。

對於資源的具體操作型別，由http動詞表示。

常用的http動詞有下面五個（括號裡是對應的sql命令）。

還有兩個不常用的http動詞。

下面是一些例子。

如果記錄數量很多，伺服器不可能都將它們返回給使用者。api應該提供引數，過濾返回結果。

下面是一些常見的引數。

引數的設計允許存在冗餘，即允許api路徑和url引數偶爾有重複。比如，get /zoo/id/animals 與 get /animals?zoo_id=id 的含義是相同的。

伺服器向使用者返回的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的http動詞）。

狀態碼的完全列表參見這裡。

如果狀態碼是4xx，就應該向使用者返回出錯資訊。一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值即可。

針對不同操作，伺服器向使用者返回的結果應該符合以下規範。

restful api最好做到hypermedia，即返回結果中提供鏈結，連向其他api方法，使得使用者不查文件，也知道下一步應該做什麼。

比如，當使用者向api.example.com的根目錄發出請求，會得到這樣乙個文件。

上面**表示，文件中有乙個link屬性，使用者讀取這個屬性就知道下一步該呼叫什麼api了。rel表示這個api與當前**的關係（collection關係，並給出該collection的**），href表示api的路徑，title表示api的標題，type表示返回型別。

hypermedia api的設計被稱為hateoas。github的api就是這種設計，訪問api.github.com會得到乙個所有可用api的**列表。

從上面可以看到，如果想獲取當前使用者的資訊，應該去訪問api.github.com/user，然後就得到了下面結果。

上面**表示，伺服器給出了提示資訊，以及文件的**。

（1）api的身份認證應該使用oauth 2.0框架。

（2）伺服器返回的資料格式，應該盡量使用json，避免使用xml。

（完）