Spring Boot整合Swagger2

本文详细介绍如何在SpringBoot项目中整合Swagger2,包括POM依赖导入、配置类编写及启动项目的具体步骤。

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

Spring Boot整合Swagger2

关于swagger2的阐述以及使用等此处不做描述。

整合步骤

整合之前需要先创建一个Spring Boot的web项目。

POM依赖导入

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

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

配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

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

    public ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("整合演示API")
                .description("提供给XX调用和交互的API接口")
                .version("1.0")
                .build();
    }
}
  • basePackage用于配置需要生成接口文档的包路径。
  • apiInfo主要是针对生成的接口文档的标题,描述等的配置
  • @EnableSwagger2注解不能省略

启动

启动项目并访问路径:http(s)://localhost:8080/swagger-ui.html


评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值