0

Я использую swagger-play с игровым сервером 2.5 для создания определения swagger. Мой API ожидает заголовок X-Auth-Token. Как я могу аннотировать мои классы API, чтобы swagger-play генерировал правильные определения безопасности? Это только кажется, поддерживает oauth2 ...Как добавить определение безопасности apiKey к API-интерфейсу swagger?

+0

Я не думаю, что swagger-play поддерживает securityDefinitions. – jbrown

ответ

0

Вы можете попробовать добавить что-то вроде этого к вашей основной swagger.yml файла:

securityDefinitions: 
    key: 
    type: apiKey 
    in: header 
    name: key 
    value: 
    type: apiKey 
    in: header 
    name: value 

Для дальнейшей подробной информации, Вы можете обратиться к: https://apihandyman.io/writing-openapi-swagger-specification-tutorial-part-6-defining-security/

+0

swagger-play не имеет файла swagger.yml. Он автоматически генерируется из аннотаций и конфигов. – jbrown

+0

Да, это автогенерация, но вы можете определить базовый файл swagger.yml. Для справки вы можете увидеть шаг 2 @ https://github.com/iheartradio/play-swagger – Sangeeta

+0

Я использую swagger-play не play-swagger ... – jbrown