RESTful API的最佳實踐

在設計RESTful API時，遵循最佳實踐可以提高API的可用性、可維護性和擴展性。以下是一些關鍵的最佳實踐。

路徑名稱避免動詞

在RESTful API設計中，應使用HTTP方法來表達資源的操作行為，而不是在路徑中使用動詞。例如，使用GET /orders獲取訂單列表，而不是GET /getOrders。

curl -X GET http://httpbin.org/orders



curl -X GET "http://httpbin.org/getOrders"

URI使用復數形式

資源命名應使用復數形式，以表示資源的集合，如/orders而不是/order。這有助于區分單個資源和資源集合。

curl -X GET "http://httpbin.org/orders"



curl -X GET "http://httpbin.org/order"

善用HTTP狀態碼

正確使用HTTP狀態碼可以提供關于API響應的有用信息。例如，200 OK表示請求成功，404 Not Found表示資源未找到。

curl -X GET http://httpbin.org/orders



curl -X GET http://httpbin.org/orders/nonexistent

版本管理

隨著業務的發展，API可能需要更新和迭代。通過在API路徑、查詢參數或頭部中包含版本號，可以管理不同版本的API。

curl http://httpbin.org/v1/orders



curl http://httpbin.org/v2/orders

Apache APISIX助力RESTful API

Apache APISIX是一個動態、實時、高性能的API網關，它可以幫助我們在任何RESTful API服務上運行，并使用插件來添加新的服務和擴展其功能。

分層系統：支持業務邏輯和安全邏輯的分割

APISIX可以在業務服務器前面加一層認證邏輯，起到保護上游服務的作用，讓你的業務邏輯和安全邏輯高效解耦。

圖片來源：APISIX

Layered system：多負載均衡協議支持

APISIX作為API網關，可以設立在客戶端和服務端之間，完成不同的負載需求。支持的負載均衡算法包括roundrobin、chash、ewma等。

統一接口：使歷史API更加RESTful

對于已經存在很久的歷史API，如果沒有很好地遵循RESTful API準則，可以通過APISIX來封裝新的API以滿足不同的業務場景。

使用proxy-rewrite改寫客戶端請求

例如，歷史版本API有/getOrder接口，我們可以通過proxy-rewrite插件來將API請求代理到歷史API上：

curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

{

    "methods": ["GET"],

    "uri": "/orders",

    "plugins": {

        "proxy-rewrite": {

            "uri": "/getOrder",

            "scheme": "http",

        }

    },

    "upstream": {

        "type": "roundrobin",

        "nodes": {

            "127.0.0.1:80": 1

        }

    }

}'

使用response-rewrite插件改寫服務端響應

當我們的歷史API存在響應狀態碼不規范時，可以通過response-rewrite代理response響應從而達到修改響應狀態碼的目的。

curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '

{

    "methods": ["GET"],

    "uri": "/orders",

    "plugins": {

        "response-rewrite": {

            "status_code": 201,

            "body": "{"code":"ok","message":"new json body"}",

            "vars":[

                [ "status","==",200 ]

            ]

        }

    },

    "upstream": {

        "type": "roundrobin",

        "nodes": {

            "127.0.0.1:80": 1

        }

    }

}'

FAQ

問：RESTful API與SOAP API有什么區別？

答：RESTful API基于HTTP協議，使用JSON或XML格式傳輸數據，而SOAP API使用SOAP協議，通常基于XML格式。RESTful API更輕量級，易于理解和實現。

問：如何設計一個良好的RESTful API？

答：設計良好的RESTful API需要遵循REST的核心約束和最佳實踐，如使用HTTP方法表達行為，URI使用復數形式，善用HTTP狀態碼等。

問：API版本管理有什么好處？

答：API版本管理可以確保向后兼容，允許開發者在不影響現有客戶端的情況下更新和改進API。

問：為什么需要API網關？

答：API網關可以提供請求路由、負載均衡、認證授權、監控和日志記錄等功能，有助于管理和保護后端服務。

問：Apache APISIX有哪些主要功能？

答：Apache APISIX是一個動態、實時、高性能的API網關，支持動態路由、負載均衡、動態上游、灰度發布、服務熔斷、身份認證、可插拔擴展等功能。

總結，RESTful API以其簡潔性和高效性成為現代API設計的主流選擇。Apache APISIX作為強大的API網關，能夠幫助我們更好地實現和管理RESTful API，提高系統的可維護性和擴展性。希望本文能幫助您更好地理解和應用RESTful API。