简单实现springboot集成swagger

最新推荐文章于 2025-04-29 12:59:17 发布

Difcipo

最新推荐文章于 2025-04-29 12:59:17 发布

阅读量212

点赞数

分类专栏： springboot 后端笔记文章标签： spring boot swagger2

本文链接：https://blog.youkuaiyun.com/weixin_42188677/article/details/118412072

版权

springboot 同时被 3 个专栏收录

7 篇文章

订阅专栏

笔记

6 篇文章

订阅专栏

后端

4 篇文章

订阅专栏

这篇博客介绍了如何在Spring Boot项目中集成Swagger2，通过添加相关依赖和配置，实现API的自动化文档生成。文章详细讲解了Swagger的配置步骤，包括启用Swagger2、创建Docket bean以及设置apiInfo。此外，还列举了一些常用注解，如@Api、@ApiOperation、@ApiImplicitParam等，用于详细描述接口及参数。最后，提供了测试 Swagger UI 的URL，帮助开发者快速查看和测试API。

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

属于自己的文档，只用于简单参考。

添加依赖

<!--swagger2的依赖-->
		<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>

添加Swagger配置

@Configuration
@EnableSwagger2  //开启swagger
public class SwaggerConfig{
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                // basePackage() 配置要为哪个包下的接口生成api文档
                // withMethodAnnotation(ApiOperation.class) 给添加了该注解的方法生成接口文档
                // any() 给任意方法生成接口文档
                .apis(RequestHandlerSelectors.basePackage("com.cai.primeton.controller"))
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
//                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo(){
        Contact contact = new Contact("csp","","13298280305@163.com");
        return new ApiInfoBuilder()
                .title("接口文档")
                .description("添加描述")
                .contact(contact)
                .version("1.0")
                .build();
    }
}

常用注解

@Api()
	属性：tags = “”
@ApiOperation()  标注在要生成接口文档的方法上
	属性：value = ""  方法说明
@ApiImplicitParam() 标注在要生成接口文档的方法上，用户介绍参数
	属性： name = ""  参数名
		        value = ""   参数说明