Swagger学习-springboot集成

作者:公子世无双2024.02.19 04:15浏览量:5

简介:本文将介绍如何使用Swagger在Spring Boot中集成API文档,使接口的文档在线自动生成,并进行功能测试。

在当今的软件开发中,API文档的生成和测试变得尤为重要。Swagger是一种强大的工具,可以帮助我们轻松地生成、描述和测试API。本文将介绍如何将Swagger集成到Spring Boot项目中,以便自动生成接口文档并执行功能测试。

首先,我们需要配置pom.xml文件来引入Swagger的相关依赖。打开pom.xml文件,找到标签,并在其中添加以下内容:

  1. <dependency>
  2. <groupId>io.springfox</groupId>
  3. <artifactId>springfox-swagger2</artifactId>
  4. <version>2.9.2</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>io.springfox</groupId>
  8. <artifactId>springfox-swagger-ui</artifactId>
  9. <version>2.9.2</version>
  10. </dependency>

完成配置后,重新构建项目,Maven会自动下载并添加Swagger的相关依赖。

接下来,我们需要在Spring Boot项目中创建一个Swagger配置类。在项目中找到一个空白的Java类,命名为SwaggerConfig,并添加以下代码:

  1. import springfox.documentation.builders.ApiInfoBuilder;
  2. import springfox.documentation.builders.PathSelectors;
  3. import springfox.documentation.builders.RequestHandlerSelectors;
  4. import springfox.documentation.service.ApiInfo;
  5. import springfox.documentation.service.Contact;
  6. import springfox.documentation.spi.DocumentationType;
  7. import springfox.documentation.spring.web.plugins.Docket;
  8. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  9. import org.springframework.context.annotation.Bean;
  10. import org.springframework.context.annotation.Configuration;
  11. import springfox.documentation.builders.ApiInfo;