Swagger: ApiSecurity does not expose ApiKey authorisation option
I'm submitting a...
[ ] Regression
[x] Bug report
[ ] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.
Current behavior
By adding decorator on my controller route I should get option to use ApiKey authorization method. And it also fails to add header to request.
- Shows correctly at global option to add auth.
- Fails to show at secured route
Related issue: #484
Expected behavior
Option does not show at all.
Minimal reproduction of the problem with instructions
OpenAPI Configuration
const options = new DocumentBuilder()
.addApiKey({ type: 'apiKey', name: 'ApiKeyAuth', in: 'header' })
.addBearerAuth()
.setTitle('API Generator')
.setDescription('API Gateway')
.setVersion('1.0')
.build();
Route example
@Post('webhook/process')
@ApiConsumes('multipart/form-data')
@ApiSecurity('ApiKeyAuth')
@ApiBody({
schema: {
type: 'object',
properties: {
file: {
type: 'string',
format: 'binary'
},
uuid: {
type: 'string'
}
}
}
})
@UseInterceptors(FileInterceptor('file'))
@UseGuards(LocalApiKeyGuard)
webHookProcess(@UploadedFile() file, @Body('region') region: string, @Body('uuid') uuid: string) {
return this.queueService.uploadImageAndProcess({ file, userId: uuid, region, name: file.originalname });
}
What is the motivation / use case for changing the behavior?
Environment
Nest version: 7.0.7
Nest-Swagger version: 4.5.1
For Tooling issues:
- Node version:
v13.6.0
- Platform:
Mac, Linux
djedlajn
All 4 comments
I have found solution tho I think it should be documented in better way. So I will probably make and PR and reference this issue.
Solution
const options = new DocumentBuilder()
.addApiKey({ type: 'apiKey', name: 'api_key', in: 'header', description: 'API Key For External calls' })
.addBearerAuth()
.setTitle('API Generator')
.setDescription('API Gateway')
.setVersion('1.0')
.build()
Where I assume name needs to match optional array in @ApiSecurity decorator. Name is also the name of the entry that will be added in my case to header of the request.
And on controller itself decorator should look like: @ApiSecurity('api_key', ['api_key']) where second argument is array of security dependencies I assume. Documentation as noted above should be improved in this regard.
djedlajn
on 8 Apr 2020
@djedlajn PRs are more than welcome :) Feel free to create one here https://github.com/nestjs/docs.nestjs.com And I'm glad you found the solution!
kamilmysliwiec
on 8 Apr 2020
Maybe it helps someone, for me to get it to work, I had to add the name as well.
addApiKey({ type: 'apiKey', name: 'X-API-KEY', in: 'header' }, 'X-API-KEY')
Benny739
on 24 Jun 2020
X-API-KEY
Thanks! it worked for me :)
enriqueaparicio-ph
on 10 Nov 2020
Related issues
vh13294
路
4Comments
ph55
路
3Comments
mogusbi
路
3Comments
kalaivanan-muthusamy
路
4Comments
leefordjudes
路
4Comments
Most helpful comment
Maybe it helps someone, for me to get it to work, I had to add the name as well.