如何在swagger-play API中添加apiKey安全定义？

Question

我使用swagger-play和play 2.5服务器来创建一个swagger定义。我的API需要X-Auth-Token标头。如何对API类进行注释，以便swagger-play生成正确的安全性定义？它似乎只支持oauth2 ......

Answer 1

您可以尝试将这样的内容添加到基本的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/