命名 API 端點的 7 個最佳實踐

API 端點是兩個軟件程序之間的連接點。API 有每個資源的端點。端點指定資源在服務器上的確切位置。

當客戶端應用程序從服務器請求信息時，它會通過 API。然後訪問請求並處理來自服務器的響應。然後，API 將請求的信息從端點傳輸到應用程序。

如果您的 API 可以通過其端點進行有效通信，那麼您的 API 就是高效的。它使用戶更容易訪問資源，改善用戶體驗。

API端點如何工作？

集成系統通過 API 進行通信。一個系統使用 SOAP 或 REST 等格式向 API 發送請求。服務器接收請求並將響應傳回 API。該請求資源的位置是端點。

在端點處理請求之前，客戶端必須提供 URL、標頭和正文。標頭包含有關請求的元數據和發送到服務器的正文詳細信息數據。服務器還可以連接到 API 方法可以訪問的數據庫。

API 端點通常使用 HTTP 方法，例如 GET、DELETE、PATCH 或 POST。這些方法決定瞭如何使用端點。當客戶端發送請求時，它需要製定它以包括請求方法和 URL，例如：

GET https://example.com/books/authors

命名很困難，無論是 API 端點、聯網硬件設備，還是函數和變量。您應該了解一些可用於確保您的 API 端點是資產的最佳實踐。

1.使用正斜杠

始終使用正斜杠來分隔 URI 資源。斜杠還有助於顯示資源層次結構。下面是一個例子：

2.使用名詞，而不是動詞

您應該只使用名詞來命名資源。名詞描述資源的用途，而動詞描述資源的作用。這是命名 API 端點的好方法和壞方法的示例。

好的命名：

錯誤的命名：

http://example.com/api/books

3.使用複數名詞，而不是單數

您應該始終以復數名詞命名您的 API 端點。這向用戶表明服務器上有多個資源。使用單數名詞可能會使用戶誤以為只有一種資源。

好的命名：

錯誤的命名：

http://example.com/api/books/3

4.使用小寫字母

您應該以小寫形式鍵入所有 URL。這包括 API 端點 URL。這是一個例子：

好的命名：

http://example.com/api/Books/3

錯誤的命名：

http://example.com/api/books/3

5. 使用連字符分隔單詞

使用連字符分隔組合的單詞。連字符比駝峰式或下劃線更易讀。它們也更適合 SEO 目的。

好的命名：

錯誤的命名：

6. 不要添加文件擴展名

您無需向 API 端點添加文件擴展名。儘管它不影響輸出，但擴展會使閱讀資源變得更加困難。它還使資源的靈活性降低，如果將來擴展發生變化，它就會中斷。

好的命名：

錯誤的命名：

7.包括版本控制

您應該始終根據版本命名您的 API 端點。如果您要對 API 進行重大更改，這一點很重要。它有助於區分資源來自的兩個或多個 API 版本。您可以在端點的開頭指示版本。

例如：

為什麼要考慮 API 最佳實踐？

API 已成為現代編程的支柱。他們改善協作、鼓勵創新並提高應用程序安全性。

無論是使用新工具還是管理現有工具，API 都可以簡化流程。因此，擁有可改善用戶體驗的端點至關重要。API 端點的命名和結構決定了 API 的性能。

確保您使用最佳實踐來創建高效的 API 端點。