將 Swagger API 導入 Postman

一、概述

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

2. Swagger 和 OpenAPI

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

3.郵遞員

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 並導航到左側的APIs選項，然後單擊Import以查看可用的不同選項：

5.1。導入文件

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

5.2.導入鏈接

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

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

並通過 Postman 的相同鏈接導入它：

5.3.通過原始文本導入

我們也可以將 JSON 粘貼為原始文本來導入 API：

5.4.通過代碼庫導入

要從存儲庫導入 API，我們需要登錄 Postman 。要從 GitHub 導入，例如，讓我們按照以下步驟操作：

1. 導航到Code Repository選項卡。
2. 點擊GitHub 。
3. 確認 GitHub 賬號，授權postmanlabs訪問倉庫。完成後，返回 Postman 應用程序以執行進一步的步驟。
4. 在 Postman 上，選擇**organization** 、 **repository**和**branch** ，然後單擊Continue 。
5. 確認我們需要導入的 API ，然後單擊Import 。

六，結論

在本文中，我們研究了將 REST API 導入 Postman 的不同方法。