PHP開發：如何利用 Swagger 維護 API 文檔-php教程-PHP中文網

PHP開發：如何利用 Swagger 維護 API 文檔

WBOY

發布： 2023-06-15 09:38:01

原創

1014 人瀏覽過

隨著網路的快速發展，Web API 成為了支撐開放式應用的核心所在。 API 的可擴展性和可重複使用性使得它們成為了不同系統之間資料交換和協同的重要工具。然而，開發人員往往會遇到一個常見的問題：如何維護 API 文件並確保 API 的可靠性？

Swagger 是一個開源的框架，它提供了 API 設計、文件編制、測試和部署的全套解決方案。本文將探討如何使用 Swagger 維護 API 文檔，以便更好地管理和維護現有的 API。

一、Swagger 的基礎概念

Swagger 透過描述 API 的 JSON 或 YAML 規範檔案來建立和文件化 API。這個文件稱為 Swagger 規範。

Swagger 規範檔案包含以下概念：

路徑：API 路徑是資源的識別碼。例如，/users 表示所有用戶，/users/{id} 表示一個用戶。
方法：一種 HTTP 方法，例如 GET、PUT、POST、DELETE 和 HEAD。
參數：請求參數（HTTP 請求正文、URL 路徑和/或查詢字串參數）。
回應：HTTP 回應結構、狀態碼和回應體（HTTP 回應正文）類型。
模型：資料傳輸物件（DTO）與回應物件的結構。
標籤：將 API 資源進行邏輯分組，方便閱讀。

二、Swagger 的使用

安裝Swagger UI

Swagger UI 是一個開源的工具，允許我們在一個互動的介面中顯示Swagger 規格檔。它的主要作用是提供一個清晰而可互動的文檔，並允許我們測試和調試 API。

使用以下命令安裝Swagger UI：

npm install swagger-ui-dist

登入後複製

編寫Swagger 規範文件

編寫Swagger 規範文件，以說明我們的API 的路徑、方法、參數、響應等資訊。

下面是一個範例：

swagger: '2.0'
info:
  title: User API Root
  version: 1.0.0
paths:
  /users:
    get:
      tags:
        - users
      description: Returns all users
      produces:
        - application/json
      responses:
        200:
          description: A list of user names
          schema:
            type: object
            properties:
              id:
                type: integer
                example: 123
              name:
                type: string
                example: John Doe

登入後複製

在這個範例中，我們定義了一個API 路徑「/users」和一個GET 方法，傳回一個包含「id」和「name」的JSON對象數組作為響應。

整合 Swagger UI

在你的 Web 應用程式中整合 Swagger UI，以便顯示你的 Swagger 規格檔。新增以下 HTML 程式碼到你的 Web 頁面：

<!DOCTYPE html>
<html>
<head>
  <meta charset="UTF-8">
  <title>Swagger UI</title>
  <link rel="stylesheet" type="text/css" href="./node_modules/swagger-ui-dist/swagger-ui.css">
</head>
<body>
  <div id="swagger-ui"></div>
  <script src="./node_modules/swagger-ui-dist/swagger-ui-bundle.js"></script>
  <script>
    window.onload = function() {
      SwaggerUIBundle({
        url: "https://api.example.com/swagger",
        dom_id: '#swagger-ui',
        deepLinking: true,
        presets: [
          SwaggerUIBundle.presets.apis,
          SwaggerUIBundle.SwaggerUIStandalonePreset
        ],
        plugins: [
          SwaggerUIBundle.plugins.DownloadUrl
        ],
        layout: "StandaloneLayout"
      })
    }
  </script>
</body>
</html>

登入後複製

在這個範例中，我們在 HTML 檔案中載入 Swagger UI，並將 Swagger 規範檔案的 URL 位址傳遞給 SwaggerUIBundle，以呈現 API 文件。