SpringBoot项目中配置Swagger

最新推荐文章于 2025-05-28 11:25:53 发布

ASandJava

最新推荐文章于 2025-05-28 11:25:53 发布

阅读量262

点赞数

CC 4.0 BY-SA版权

文章标签： spring boot spring java

本文链接：https://blog.csdn.net/liaoweihaoren/article/details/121030185

本文档展示了如何在Spring Boot项目中配置Swagger2，通过引入相关依赖并创建Swagger2配置类，实现API的文档化。步骤包括在pom.xml中添加Swagger2依赖，创建Swagger2配置类并设置API信息，最后启动项目访问swagger-ui.html即可查看和测试API。

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

1、配置pom.xml

<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、粘贴Swagger2代码

首先建立config文件夹，然后新建Swagger2.java文件，粘贴代码

package com.example.szlzzhcu_ht.config;

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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {
	@Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())  //apiInfo()用来创建该Api的基本信息（这些基本信息会展现在文档页面中）
                .select()            //返回一个ApiSelectorBuilder实例用来控制哪些接口暴露给Swagger来展现
                ////为当前包路径
                .apis(RequestHandlerSelectors.basePackage("com.nercita.szlzzhc"))
                .paths(PathSelectors.any())
                .build();
    }
 
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("Spring Boot中使用Swagger2构建RESTful APIs")
                .version("1.0")
                .build();
    }
}

http://localhost:端口号/swagger-ui.html#! 启动项目数据网址就能点开