一、概述

在本文中，我们将了解如何将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 的不同方法。