SpringBoot集成Swagger2

最新推荐文章于 2023-04-20 16:00:03 发布

JavaMrSun

最新推荐文章于 2023-04-20 16:00:03 发布

阅读量283

点赞数

分类专栏： Spring Boot

本文链接：https://blog.youkuaiyun.com/Java_Mrsun/article/details/83749575

版权

Spring Boot 专栏收录该内容

20 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中集成Swagger2，通过简单几步配置，实现RESTful接口的在线文档生成，便于开发和测试。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

Swagger2是一款RESTFUL接口在线生成工具，对于我们开发非常方便

第一笔引入pom：

<!-- swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>${swagger2.version}</version>
    <exclusions>
        <exclusion>
            <artifactId>mapstruct</artifactId>
            <groupId>org.mapstruct</groupId>
        </exclusion>
    </exclusions>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>${swagger2.version}</version>
</dependency>

第二步：

在application文件上加上@EnableSwagger2注解开启

第三步（可以不要）：配置swagger

package com.springbootmybatisdemo;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2 {
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .description("Swagger2接口文档")
                .termsOfServiceUrl("https://blog.youkuaiyun.com/Java_Mrsun")
                .contact("李太阳")
                .version("1.0")
                .build();
    }
}

第四部（可不要）：在接口上添加相关注释