SpringBoot集成Swagger(手把手教你4步成功)

Spring Boot是一个用于构建Java应用程序的开发框架，而Swagger是一个用于设计、构建和文档化RESTful API的工具。

在Spring Boot应用程序中集成Swagger，可以方便地生成API文档，并且可以通过Swagger UI进行可视化展示和测试。

步骤1：新建一个springboot项目

添加web框架，如下图所示：

 

步骤2：添加Swagger依赖

在项目的pom.xml文件中添加Swagger的依赖：

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

 

步骤3：创建Swagger配置类

创建一个Java类，用于配置Swagger，如下所示：

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}

上述配置类使用了@Configuration注解，表示这是一个配置类，@EnableSwagger2注解用于启用Swagger。

在上述配置中，.apis(RequestHandlerSelectors.basePackage(“com.example.controller”))用于指定扫描的Controller包路径，你需要将其替换为你实际的Controller包路径。

 

步骤4：启动应用程序

使用Spring Boot的方式启动应用程序，在浏览器中访问以下URL。

http://localhost:8080/swagger-ui/index.html

即可查看生成的API文档和使用Swagger UI进行测试，如下图所示：

通过上述步骤，你就成功地将Swagger集成到了Spring Boot应用程序中。

现在可以使用Swagger生成的API文档，并通过Swagger UI进行可视化展示和测试。

以上就是springboot集成swagger详解，更多内容请查看：SpringBoot教程(万字图文详解)

mikechen

mikechen睿哥，10年+大厂架构经验，资深技术专家，就职于阿里巴巴、淘宝、百度等一线互联网大厂。

关注「mikechen」公众号，获知最新一线技术干货！