概述

本文将介绍如何将Swagger API导入Postman。

2. Swagger与OpenAPI

Swagger是一个开源的规则集、规范和工具,用于开发和描述RESTful API。然而,自2021年起,OpenAPI已经成为行业标准规范,而Swagger则指代相关的工具。

3. Postman

Postman是一个构建和使用API的平台,它简化了API生命周期的每个步骤,并促进了协作。我们可以使用Postman在不编写任何代码的情况下测试API。

我们可以在独立应用或浏览器扩展中使用它。

4. 应用

我们可以处理任何现有的应用程序,或者可以从头创建一个简单的应用程序,暴露出RESTful API(参见:/spring-rest-api的Swagger 2文档)。

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描述:

Swagger-UI

我们还可以查看生成的RESTful API的文档:

Swagger-API_Docs

5. 导入到Postman

有多种方式将API导入Postman,但通常需要Swagger或OpenAPI定义以某种文本格式(如JSON)存在。

打开Postman,导航到左侧的“APIs”选项,然后点击“导入”查看可用的选项:

Postman API导入

5.1. 导入文件

如果我们有一个Swagger JSON文件,可以通过Postman的文件选项导入:

Postman API导入文件

5.2. 导入链接

如果我们有Swagger-UI的链接,可以直接使用链接将API导入Postman。

复制Swagger-UI中的API链接如下:

Swagger 复制链接

然后通过Postman使用相同的链接导入:

Postman API导入链接

5.3. 通过纯文本导入

我们也可以直接粘贴JSON作为纯文本来导入API:

Postman API导入纯文本

5.4. 通过代码仓库导入

要从仓库导入API,我们需要在Postman上登录。例如,要从GitHub导入,按照以下步骤操作:

  1. 转到“代码仓库”标签。
  2. 点击“GitHub”。
  3. 确认GitHub账户,并授权postmanlabs访问仓库。完成后再回到Postman应用进行下一步。
  4. 在Postman中选择组织、仓库和分支,然后点击“继续”。
  5. 确认要导入的API,然后点击“导入”。

6. 总结

本文探讨了将RESTful API导入Postman的不同方法。