將 Swagger API 集成到 Postman 中

1. 概述

在本文中，我們將學習如何將 Swagger API 導入 Postman。

2. Swagger 和 OpenAPI

Swagger 是一套開源的規則、規範和工具，用於開發和描述 REST API。然而，自 2021 年之後，OpenAPI 指的是行業標準規範，而 Swagger 則指代工具。

3. Postman

Postman 是一款用於構建和使用 API 的 API 平台。Postman 簡化了 API 生命週期中的每個步驟，並實現了協作的優化。 我們可以使用 Postman 來 在不編寫任何代碼的情況下測試我們的 API。

我們可以使用獨立的應用程序或瀏覽器擴展。

4. 應用

我們可以與任何現有的應用程序合作，或者我們可以從頭創建一個簡單的應用程序，該應用程序可以暴露 REST API。

4.1. Maven 依賴

我們需要添加幾個依賴項，以便使用 Swagger 與 Swagger-UI 結合使用：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

4.2. Java 配置文件

Swagger 配置可以像以下示例一樣簡單：

@Configuration
public class SpringFoxConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
          .select()
          .apis(RequestHandlerSelectors.any())
          .paths(PathSelectors.any())
          .build();
    }
}

啓動應用程序時，我們可以檢查 Swagger-UI 並查找每個控制器的 REST API 描述：

我們還可以檢查為我們的 REST API 生成的API 文檔：

5. 在 Postman 中導入

有多種方法可以將 API 導入到 Postman 中，但在大多數情況下，需要 Swagger 或 OpenAPI 定義在某種文本格式中可用（例如，JSON）。

我們可以打開 Postman，然後導航到左側的 API 選項，然後點擊導入以查看可用的選項：

5.1. 導入文件

如果我們有 Swagger JSON 文件可用，可以通過 Postman 中的“文件”選項導入它：

5.2. 導入鏈接

如果擁有 Swagger-UI 鏈接，則可以直接使用該鏈接將 API 導入 Postman 中。

從 Swagger-UI 中複製 API 鏈接，如下所示：

然後，通過相同的鏈接在 Postman 中導入它：

5.3. 通過原始文本導入

您也可以直接將 JSON 粘貼為原始文本，以導入 API：

5.4. 通過代碼倉庫導入

為了從倉庫導入 API，您需要已登錄 Postman。例如，從 GitHub 導入時，請按照以下步驟操作：

導航到代碼倉庫選項卡。
點擊GitHub。
確認 GitHub 賬户並授權 postmanlabs 訪問倉庫。完成操作後，返回 Postman 應用程序進行後續步驟。
在 Postman 中，選擇組織、倉庫和分支，然後點擊繼續。
確認需要導入的 API 並點擊導入。

6. 結論

在本文中，我們探討了將我們的 REST API 導入 Postman 的各種方法。

知識庫 / Spring RSS 訂閱

2. Swagger 和 OpenAPI

3. Postman