springboot集成swagger

最新推荐文章于 2025-06-06 11:43:42 发布

二毛宝宝吖

最新推荐文章于 2025-06-06 11:43:42 发布

阅读量89

点赞数

文章标签： spring boot java

本文链接：https://blog.youkuaiyun.com/yylhm1125/article/details/111184823

版权

本文介绍了如何简单快捷地在SpringBoot项目中集成Swagger，通过引入相关依赖并配置SwaggerConfig，实现API文档的自动化生成。只需两步，即可在方法上使用注解，并通过访问swagger-ui.html展示和测试接口。这为接口管理和调试提供了便利。

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

springboot集成swagger很简单只要两步就好了

引入jar包`

	<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>`

写配置类SwaggerConfig，放在下面这个目录下

package com.practice.demo;

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 SwaggerConfig {

    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any()).build();
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("Kitty API Doc")
                .description("This is a restful api document of Kitty.")
                .version("1.0")
                .build();
    }

}