REST API是當今最常見的Web服務之一。它們允許包括瀏覽器應用程序在內的各種客戶端通過REST API與服務器進行通信。

因此，正確設計REST API非常重要，這樣我們就不會遇到麻煩。我們必須考慮API使用者的安全性，性能和易用性。

否則，我們會給使用我們的API的客戶帶來麻煩，這令人不愉快，并且會分散人們使用我們的API的注意力。如果我們不遵循公認的約定，那么我們會混淆API的維護者和使用它們的客戶，因為它與每個人的期望都不同。

在本文中，我們將研究如何設計REST API，以使使用它們的任何人都易于理解，面向未來，安全，快速，因為它們向可能是機密的客戶提供數據。

因為聯網應用程序有多種破壞方法，所以我們應確保使用標準的HTTP代碼，任何REST API都會優(yōu)雅地處理錯誤，以幫助消費者解決問題。

接受并使用JSON進行響應

REST API應該接受JSON作為請求有效負載，并向JSON發(fā)送響應。 JSON是用于傳輸數據的標準。幾乎每種聯網技術都可以使用它：JavaScript具有內置方法，可以通過Fetch API或其他HTTP客戶端對JSON進行編碼和解碼。服務器端技術具有無需大量工作即可解碼JSON的庫。

還有其他傳輸數據的方法。如果不將數據本身轉換為可以使用的東西（通常是JSON），框架就不會廣泛支持XML。我們無法在客戶端（尤其是在瀏覽器中）如此輕松地操作這些數據。為了進行正常的數據傳輸，最終要付出很多額外的工作。

表單數據非常適合發(fā)送數據，尤其是當我們要發(fā)送文件時。但是對于文本和數字，我們不需要表單數據來傳輸它們，因為在大多數框架中，我們可以通過直接從客戶端獲取JSON來傳輸JSON。到目前為止，這是最簡單的方法。

為了確保當我們的REST API應用使用JSON響應時，客戶端會這樣解釋，我們應該在發(fā)出請求后將響應頭中的Content-Type設置為application / json。許多服務器端應用程序框架會自動設置響應頭。一些HTTP客戶端查看Content-Type響應標頭，并根據該格式解析數據。

唯一的例外是，如果我們嘗試在客戶端和服務器之間發(fā)送和接收文件。然后，我們需要處理文件響應并將表單數據從客戶端發(fā)送到服務器。但這是另一個話題。

我們還應確保端點返回JSON作為響應。許多服務器端框架都將此作為內置功能。

讓我們看一下一個接受JSON有效負載的API示例。此示例將對Node.js使用Express后端框架。我們可以使用body-parser中間件來解析JSON請求主體，然后可以使用要返回的對象作為JSON響應調用res.json方法，如下所示：

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

app.post('/', (req, res) => {

  res.json(req.body);

});

app.listen(3000, () => console.log('server started'));

bodyParser.json（）將JSON請求主體字符串解析為JavaScript對象，然后將其分配給req.body對象。

在對application / json的響應中設置Content-Type標頭； charset = utf-8，無任何更改。 上面的方法適用于大多數其他后端框架。

在端點路徑中使用名詞代替動詞

我們不應該在端點路徑中使用動詞。相反，我們應該使用表示要檢索或操縱的端點的實體的名詞作為路徑名。

這是因為我們的HTTP請求方法已經有動詞。在API端點路徑中使用動詞是沒有用的，而且由于它不會傳達任何新信息，因此它會不必要地變長。所選動詞可能會因開發(fā)人員的想法而異。例如，有些像“ get”，有些像“ retrieve”，所以最好讓HTTP GET動詞告訴我們什么和端點做什么。

該操作應由我們正在執(zhí)行的HTTP請求方法指示。最常見的方法包括GET，POST，PUT和DELETE。

GET檢索資源。 POST將新數據提交到服務器。 PUT更新現有數據。 DELETE刪除數據。這些動詞映射到CRUD操作。

牢記上面討論的兩個原則，我們應該創(chuàng)建諸如GET / articles /之類的路由來獲取新聞文章。同樣，POST / articles /用于添加新文章，PUT / articles /：id用于更新具有給定id的文章。 DELETE / articles /：id用于刪除具有給定ID的現有文章。

/ articles代表REST API資源。例如，我們可以使用Express添加以下端點來操縱文章，如下所示：

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

app.get('/articles', (req, res) => {

  const articles = [];

  // code to retrieve an article...

  res.json(articles);

});

app.post('/articles', (req, res) => {

  // code to add a new article...

  res.json(req.body);

});

app.put('/articles/:id', (req, res) => {

  const { id } = req.params;

  // code to update an article...

  res.json(req.body);

});

app.delete('/articles/:id', (req, res) => {

  const { id } = req.params;

  // code to delete an article...

  res.json({ deleted: id });

});

app.listen（3000，（）=> console.log（'服務器已啟動'））;

在上面的代碼中，我們定義了端點來操縱文章。 如我們所見，路徑名中沒有任何動詞。 我們只有名詞。 這些動詞在HTTP動詞中。

POST，PUT和DELETE端點都將JSON作為請求正文，并且都返回JSON作為響應，包括GET端點。

具有多個名詞的名稱集合

我們應該用復數名詞來命名集合。 我們不經常只想獲得一個項目，因此我們應該與命名保持一致，應該使用復數名詞。

我們使用復數形式來與數據庫中的內容保持一致。 表通常具有多個條目，并對其進行命名以反映這一點，因此，為了與表保持一致，我們應該使用與API訪問的表相同的語言。

使用/ articles端點，所有端點都有復數形式，因此我們不必將其更改為復數形式。

嵌套分層對象的資源

處理嵌套資源的端點的路徑應通過將嵌套資源附加為父資源后面的路徑名稱來完成。

我們必須確保它確保我們認為嵌套資源與數據庫表中的資源匹配。 否則，會造成混亂。

例如，如果我們希望端點獲取新聞文章的評論，則應將/ comments路徑附加到/ articles路徑的末尾。 這是假設我們在數據庫中作為文章的子項擁有評論。

例如，我們可以使用Express中的以下代碼來做到這一點：

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

app.get('/articles/:articleId/comments', (req, res) => {

  const { articleId } = req.params;

  const comments = [];

  // code to get comments by articleId

  res.json(comments);

});

app.listen（3000，（）=> console.log（'服務器已啟動'））;

在上面的代碼中，我們可以在路徑“ / articles /：articleId / comments”上使用GET方法。 我們會獲得對由articleId標識的文章的評論，然后在響應中將其返回。 我們在“ / articles /：articleId”路徑段之后添加“注釋”，以表明它是/ articles的子資源。

這是有道理的，因為評論是文章的子對象，假設每個文章都有自己的評論。 否則，這會使用戶感到困惑，因為這種結構通常被認為是用于訪問子對象的。 相同的原則也適用于POST，PUT和DELETE端點。 它們都可以為路徑名使用相同的嵌套結構。

妥善處理錯誤并返回標準錯誤代碼

為避免API用戶在發(fā)生錯誤時產生混淆，我們應該適當地處理錯誤，并返回表明發(fā)生了哪種錯誤的HTTP響應代碼。 這為API的維護者提供了足夠的信息來了解發(fā)生的問題。 我們不希望錯誤導致系統(tǒng)崩潰，因此我們可以不處理它們，這意味著API使用者必須處理它們。

常見的錯誤HTTP狀態(tài)代碼包括：

• 400錯誤的請求–這意味著客戶端輸入驗證失敗。

• 401未經授權-這意味著用戶無權訪問資源。 通常在用戶未通過身份驗證時返回。

• 403禁止訪問-表示用戶已通過身份驗證，但不允許訪問資源。

• 404 Not Found –表示找不到資源。

• 500內部服務器錯誤–這是一般服務器錯誤。 它可能不應該明確地拋出。

• 502錯誤的網關-這表明來自上游服務器的無效響應。

• 503服務不可用–這表示服務器端發(fā)生了意外情況（可能是服務器過載，系統(tǒng)某些部分發(fā)生故障等）。

我們應該拋出與我們的應用程序遇到的問題相對應的錯誤。 例如，如果我們想拒絕請求有效載荷中的數據，那么我們應該在Express API中返回如下所示的400響應：

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

// existing users

const users = [

  { email: 'abc@foo.com' }

]

app.use(bodyParser.json());

app.post('/users', (req, res) => {

  const { email } = req.body;

  const userExists = users.find(u => u.email === email);

  if (userExists) {

    return res.status(400).json({ error: 'User already exists' })

  }

  res.json(req.body);

});

app.listen（3000，（）=> console.log（'服務器已啟動'））;

在上面的代碼中，我們在用戶數組中包含給定電子郵件的現有用戶列表。

然后，如果我們嘗試使用用戶已經存在的電子郵件值提交有效負載，則會收到帶有“用戶已存在”消息的400響應狀態(tài)代碼，以告知用戶該用戶已經存在。 利用這些信息，用戶可以通過將電子郵件更改為不存在的郵件來糾正操作。

錯誤代碼需要附帶消息，以便維護人員有足夠的信息來解決問題，但是攻擊者無法使用錯誤內容來進行攻擊，例如竊取信息或關閉系統(tǒng)。

每當我們的API未成功完成時，我們都應通過發(fā)送錯誤信息并幫助用戶采取糾正措施來正常地失敗。

允許過濾，排序和分頁

REST API背后的數據庫可能會非常龐大。 有時，有太多數據，因此不應立即全部返回，因為它太慢或會導致系統(tǒng)崩潰。 因此，我們需要過濾項目的方法。

我們還需要分頁數據的方式，以便一次只返回一些結果。 我們不想通過嘗試一次獲取所有請求的數據來占用資源太長時間。

過濾和分頁都通過減少服務器資源的使用來提高性能。 隨著數據庫中積累的數據越多，這些功能就越重要。

這是一個小示例，其中API可以接受帶有各種查詢參數的查詢字符串，以使我們可以根據項目的字段來過濾出項目：

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

// employees data in a database

const employees = [

  { firstName: 'Jane', lastName: 'Smith', age: 20 },

  //...

  { firstName: 'John', lastName: 'Smith', age: 30 },

  { firstName: 'Mary', lastName: 'Green', age: 50 },

]

app.use(bodyParser.json());

app.get('/employees', (req, res) => {

  const { firstName, lastName, age } = req.query;

  let results = [...employees];

  if (firstName) {

    results = results.filter(r => r.firstName === firstName);

  }

  if (lastName) {

    results = results.filter(r => r.lastName === lastName);

  }

  if (age) {

    results = results.filter(r => +r.age === +age);

  }

  res.json(results);

});

app.listen（3000，（）=> console.log（'服務器已啟動'））;

在上面的代碼中，我們有req.query變量來獲取查詢參數。 然后，我們使用JavaScript解構語法通過將各個查詢參數解構為變量來提取屬性值。 最后，我們對每個查詢參數值運行filter以找到我們要返回的項目。

完成此操作后，我們將結果作為響應返回。 因此，當我們使用查詢字符串向以下路徑發(fā)出GET請求時：

/ employees？lastName = Smith＆age = 30

我們得到：

[

    {

        "firstName": "John",

        "lastName": "Smith",

        "age": 30

    }

]

作為返回的響應，因為我們按lastName和age進行了過濾。

同樣，我們可以接受頁面查詢參數，并在（page-1）* 20到page * 20的位置返回一組條目。

我們還可以在查詢字符串中指定要排序的字段。 例如，我們可以從查詢字符串中獲取參數，其中包含我們要為其排序數據的字段。 然后，我們可以按照這些單獨的字段對它們進行排序。例如，我們可能想從URL中提取查詢字符串，例如：http://example.com/articles?sort=+author，發(fā)布日期，其中+表示上升，而-表示下降。 因此，我們按作者姓名的字母順序排序，并且發(fā)布日期從最近到最近。

保持良好的安全習慣

客戶端和服務器之間的大多數通信應該是私有的，因為我們經常發(fā)送和接收私有信息。因此，必須使用SSL / TLS進行安全保護。

SSL證書很難加載到服務器上，而且費用是免費的或非常低。沒有理由不讓我們的REST API通過安全的渠道而不是公開的方式進行通信。

人們不應該能夠訪問他們要求的更多信息。例如，普通用戶不應訪問其他用戶的信息。他們也不應訪問管理員的數據。

為了實施最小特權原則，我們需要為單個角色添加角色檢查，或者為每個用戶添加更精細的角色。

如果我們選擇將用戶分為幾個角色，則這些角色應具有覆蓋他們所有需求的權限，而不再需要其他權限。如果我們對用戶可以訪問的每個功能具有更細化的權限，那么我們必須確保管理員可以相應地向每個用戶添加和刪除這些功能。另外，我們需要添加一些可應用于組用戶的預設角色，這樣就不必手動為每個用戶執(zhí)行此操作。

緩存數據以提高性能

我們可以添加緩存以從本地內存緩存返回數據，而不是每次我們想要檢索用戶請求的某些數據時都查詢數據庫以獲取數據。 緩存的好處是用戶可以更快地獲取數據。 但是，用戶獲取的數據可能已過時。 當在生產環(huán)境中進行調試時，當我們不斷看到舊數據時出現問題時，這也可能導致問題。

緩存解決方案有很多種類，例如Redis，內存緩存等等。 隨著需求的變化，我們可以更改數據緩存的方式。

例如，Express具有apicache中間件，無需太多配置即可向我們的應用程序添加緩存。 我們可以像這樣在服務器中添加一個簡單的內存緩存：

const express = require('express');

const bodyParser = require('body-parser');

const apicache = require('apicache');

const app = express();

let cache = apicache.middleware;

app.use(cache('5 minutes'));

// employees data in a database

const employees = [

  { firstName: 'Jane', lastName: 'Smith', age: 20 },

  //...

  { firstName: 'John', lastName: 'Smith', age: 30 },

  { firstName: 'Mary', lastName: 'Green', age: 50 },

]

app.use(bodyParser.json());

app.get('/employees', (req, res) => {

  res.json(employees);

});

app.listen（3000，（）=> console.log（'服務器已啟動'））;

上面的代碼僅使用apicache.middleware引用了apicache中間件，然后得到：app.use（緩存（'5分鐘'））將緩存應用于整個應用。 例如，我們將結果緩存五分鐘。 我們可以根據需要進行調整。

版本化我們的API

如果我們對API進行任何可能會破壞客戶端的更改，則應該使用不同版本的API。 可以像當今大多數應用程序一樣，根據語義版本（例如，表示主要版本2和第六個補丁的2.0.6）完成版本控制。

這樣，我們可以逐步淘汰舊的終結點，而不必強迫所有人同時遷移到新的API。 v1端點可以為那些不想更改的用戶保持活動狀態(tài)，而v2具有其閃亮的新功能可以為準備升級的用戶提供服務。 如果我們的API是公開的，這一點尤其重要。 我們應該對其進行版本控制，以免破壞使用我們API的第三方應用。

通常通過在API路徑的開頭添加/ v1 /，/ v2 /等來完成版本控制。

例如，我們可以使用Express進行如下操作：

const express = require('express');

const bodyParser = require('body-parser');

const app = express();

app.use(bodyParser.json());

app.get('/v1/employees', (req, res) => {

  const employees = [];

  // code to get employees

  res.json(employees);

});

app.get('/v2/employees', (req, res) => {

  const employees = [];

  // different code to get employees

  res.json(employees);

});

app.listen（3000，（）=> console.log（'服務器已啟動'））;

我們只需將版本號添加到端點URL路徑的開頭即可對其進行版本控制。

結論

設計高質量REST API的最重要要點是遵循Web標準和約定以保持一致性。 JSON，SSL / TLS和HTTP狀態(tài)代碼都是現代Web的標準構建塊。

性能也是重要的考慮因素。 我們可以通過一次不返回太多數據來增加它。 另外，我們可以使用緩存，這樣就不必一直查詢數據。

端點的路徑應一致，我們僅使用名詞，因為HTTP方法指示了我們要采取的行動。 嵌套資源的路徑應位于父資源的路徑之后。 他們應該告訴我們我們正在獲取或操作的內容，而無需閱讀額外的文檔以了解它的作用。