Spring Boot 集成 Swagger 2.0 （超详细教程）

置顶清淡的粥

已于 2024-12-26 10:53:34 修改

阅读量753

点赞数 2

分类专栏： Record 文章标签： spring boot

于 2021-11-15 16:11:21 首次发布

本文链接：https://blog.youkuaiyun.com/fy512/article/details/121335475

版权

Record 专栏收录该内容

31 篇文章

订阅专栏

本文档介绍了如何在Spring Boot项目中引入Swagger2 jar包，配置 Swagger2 并启用API文档，展示了配置 Swagger 的步骤，包括创建 Swagger 配置类、设置分组、注解 Controller 层的方法。此外，还讲解了如何配置多个分组以及如何通过http://localhost:8088/swagger-ui.html访问接口文档。最后，提供了遇到问题时的参考链接。

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

1.引入Swgger依赖

		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2.编写SwaggerConfig配置类

@Configuration  //配置类
@EnableSwagger2  //开启swagger2的自动配置
@Profile({"dev","test"})//此注解是在哪个环境下生效，生产环境不能轻易暴露接口
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                //配置分组 如果没有 默认default
				//.groupName("hello")
                
                //是否启用swagger (true 开启  是false浏览器无法访问)
            	//.enable(false)
                .select()
                //指定需要扫描的包路径  注解有@api的API
               	.api.apis(RequestHandlerSelectors.basePackage("com.ceshi.controller"))
                //指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 项目信息
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
        		//设置文档标题(API名称)
                .title("测试swagger项目文档")
				//版本号
                .version("1.0")
				//文档描述
                .description("接口文档")
				//服务条款URL
                .termsOfServiceUrl("http://localhost:8088/")
                //联系人信息
                .contact(new Contact("zk","https://aaa/bb","12345@gmail.com"))
                .build();
    }

}

3.编写Controller Api类

@RestController
//api
@Api(value = "测试swaggerAPI", tags = "你好接口", description = "测试Swagger")
public class CeShiSwagger {

    @RequestMapping("/say")
    public String sayHello(){
        return "hello";
    }
}

4.启动

http://localhost:8088/swagger-ui.html

在这里插入图片描述

Api接口如下：
在这里插入图片描述

在这里插入图片描述

5.多分组配置

如果需要配置多个分组，配置多个 docker就可以

@Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group1");
    }
    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group2");
    }
    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("group3");
    }