如何为基于注解的swagger生成添加头部？
如何为基于注解的swagger生成添加头部？
提问于 2019-01-25 13:29:00
考虑以下示例：
@RequestMapping("myPath")
public Mono<MyDto> myMethod(@RequestParam(value = "amount") Long amount, @AuthenticationPrincipal MyUser user) {
} 为了从参数列表中跳过MyUser，我将@AuthenticationPrincipal添加到exclusions和springfox生成的swagger文档中，如下所示：
"/myPath": {
"get": {
"tags": [
"my-controller"
],
"summary": "myMethod",
"operationId": "myMethodUsingGET",
"produces": [
"*/*"
],
"parameters": [
{
"name": "amount",
"in": "query",
"description": "amount",
"required": true,
"type": "integer",
"format": "int64"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/Mono«MyDto»"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
}
},
"deprecated": false
}
}下面是spring的配置：
@Configuration
@EnableSwagger2WebFlux
public class SwaggerConfig {
@Bean
public Docket api() {
Class[] clazz = {AuthenticationPrincipal.class};
return new Docket(DocumentationType.SWAGGER_2)
.select()
.paths(PathSelectors.any())
.build()
.ignoredParameterTypes(clazz);
}
}有没有办法为指定了@AuthenticationPrincipal的每个路径在springfox项目生成的swagger文档中添加一个头文件？例如，忽略MyUser类作为参数(或参数组)，并将其替换为所有找到@AuthenticationPrincipal的@RequestMapping方法的头(如My-Auth-Header)。
回答 1
Stack Overflow用户
发布于 2019-01-25 13:40:16
这是一个如何使用名为Auithorization的header参数添加JWT令牌的示例
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build()
.globalOperationParameters(
Collections.singletonList(new ParameterBuilder()
.name("Authorization")
.description("JWT Authorization token")
.modelRef(new ModelRef("string"))
.parameterType("header")
.required(false)
.build()));
}
}页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接：
https://stackoverflow.com/questions/54366267
复制相关文章
相似问题
如何为rest端点@GetMapping("/**")添加swagger注解？
Springdoc中基于Swagger注解的描述自动生成
Swagger注解和Swagger spec 2.0
从java注解生成swagger文档，缺少安全定义
如何为宿主Swagger生成活动Swagger页面？
添加站长 进交流群
领取专属 10元无门槛券
AI混元助手 在线答疑
关注 腾讯云开发者公众号
洞察 腾讯核心技术
剖析业界实践案例
腾讯云开发者
