【二】springboot整合自定义swagger

本文档介绍了如何在SpringBoot项目中整合Swagger,并自定义配置以添加Token参数,用于接口测试时的身份验证。首先,通过创建Swagger配置类并使用`@EnableSwagger2`注解开启Swagger,然后在配置类中添加全局操作参数来设置Token。此外,还提到了`@Profile`注解在多环境配置中的使用,以及如何在不同环境的YML配置文件中激活特定的Swagger配置。

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

 

互相交流入口地址 

整体目录:

【一】springboot整合swagger

【二】springboot整合自定义swagger

【三】springboot整合token

【四】springboot整合mybatis-plus

【五】springboot整合mybatis-plus

【六】springboot整合redis

【七】springboot整合AOP实现日志操作

【八】springboot整合定时任务

【九】springboot整合redis实现启动服务时热点数据保存在全局和缓存

【十】springboot整合quartz实现定时任务优化

【十一】springboot整合异步调用并获取返回值

【十二】springboot整合WebService

【十三】springboot整合WebService关于传参数

【十四】springboot整合WebSocket

【十五】springboot整合WebSocket实现聊天室

【十六】RabbitMQ基础篇(下载安装并基础使用,内含各种坑问题)

【十七】RabbitMQ基础篇(延迟队列和死信队列实战)

【十八】springboot实现自定义全局异常处理

【十九】初学Kafka并实战整合SpringCloudStream进行使用

【二十】springboot整合ElasticSearch实战(万字篇)

【二十一】springboot整合过滤器实战

【二十二】springboot整合拦截器实战并对比过滤器

【二十三】springboot整合activiti7(1)实战演示篇

【二十四】springboot整合spring事务详解以及实战

【二十五】springboot使用EasyExcel和线程池实现多线程导入Excel数据

【二十六】springboot整合jedis和redisson布隆过滤器处理缓存穿透

【二十七】springboot实现多线程事务处理

【二十八】springboot之threadLocal参数解析器实现session一样保存当前登录功能 

【二十九】springboot整合logback实现日志管理

【三十】springboot项目上高并发解决示例

        介绍:接下来我会把学习阶段学到的框架等知识点进行整合,每一次整合是在前一章的基础上进行的,所以后面的整合不会重复放前面的代码。每次的demo我放在结尾,本次是接着上一章的内容延续的,只增加新增的或者修改的代码。

        场景:当在swagger上进行接口测试时,想要新增token参数,如下:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16​​

         因此,swagger的默认配置是不行的(直接在启动类上面加@EnableSwagger2注解开启)

        开启默认配置的swagger:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16​​

         若想实现以上场景,需要使用自定义swagger配置。

第一步:新增配置类

        展示目录结构:

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_20,color_FFFFFF,t_70,g_se,x_16​​

        swagger配置文件:

@Configuration
@EnableSwagger2
@Profile("swagger")
public class SwaggerConfig {
	/**
	 * 创建API应用 apiInfo() 增加API相关信息
	 * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
	 * 本例采用指定扫描的包路径来定义指定要建立API的目录。
	 *
	 * @return
	 */
	@Bean
	public Docket createRestApi() {
		// 选择那些路径和api会生成document
		return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping("/").select()
				// 对所有api进行监控
				.apis(RequestHandlerSelectors.any())
				.apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build()
				// 配置token
				.globalOperationParameters(setHeaderToken());
	}

	/**
	 * 配置token
	 * 
	 * @return
	 */
	private List<Parameter> setHeaderToken() {
		ParameterBuilder tokenPar = new ParameterBuilder();
		List<Parameter> pars = new ArrayList<>();
		tokenPar.name("Authorization").description("token").modelRef(new ModelRef("string")).parameterType("header")
				.required(false).build();
		pars.add(tokenPar.build());
		return pars;
	}

	/**
	 * 创建该API的基本信息(这些基本信息会展现在文档页面中)
	 * 
	 * @return
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("测试接口文档").description("测试接口文档").version("1.0").build();
	}

}
  • @Configuration:用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器,简而言之就是在Spring启动时会将该类识别成一个配置类
  • @EnableSwagger2:开启swagger,此处也需要使用。
        到此处即可完成使用自定义的swagger,若有其他需求修改该配置类即可,另外此处另外提到一个注解Profile,此处可以不使用,在实际开发中可能存在多个环境,测试环境,正式环境等,可能需要使用不同的配置,此时可以使用Profile注解。
        @Profile("swagger"):指定组件在哪个环境的情况下才能被注册到容器中,不指定,任何环境下都能注册这个组件。

        实际使用: 

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_18,color_FFFFFF,t_70,g_se,x_16​​

        yml配置文件在开发时可能存在多个,因此可以指定具体哪一个环境可以开启该配置,如下图,在想要开启该配置的环境的yml文件里加上如下代码即可。

watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCPeuKZgA==,size_16,color_FFFFFF,t_70,g_se,x_16​​

         active后面的值是配置文件里面profile注解里面的参数值。profile注解的具体使用就不展开了。

        到此完毕,接下来会继续更新加强整合,尽情期待。

        访问地址:http://localhost:8082/swagger-ui.html或者http://localhost:8082/doc.html

### 如何在 Spring Boot 2 中整合 Swagger #### 添加依赖项 为了使Swagger能够顺利运行于Spring Boot环境中,需向`pom.xml`文件中加入特定的Maven依赖。这些依赖允许开发者利用Swagger的功能来增强API文档的质量和交互体验[^1]。 ```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> ``` #### 启用 Swagger 支持 要在应用程序内激活Swagger的支持,在主应用类上添加`@EnableSwagger2Doc`注解是一种方法;另一种常见的方式是在配置类里使用`@EnableSwagger2`并定义Docket Bean以定制化API文档的信息展示逻辑[^3][^4]。 ```java @SpringBootApplication @EnableSwagger2Doc public class App { public static void main(String[] args) { SpringApplication.run(App.class, args); } } ``` 对于更详细的自定义设置,则可以通过创建一个名为`SwaggerConfig`的Java配置类实现: ```java @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("com.example.demo")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Spring Boot Demo中使用Swagger2构建RESTful APIs") .version("1.0.0") .build(); } } ``` 上述代码片段展示了如何通过指定包路径以及选择所有路径的方式来筛选需要被记录下来的API端点,并设置了API文档的基础信息如标题与版本号等属性[^4]。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小z♂

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值