OpenAPI 3 Пользовательский тип в заголовке авторизации

Question

Я ищу правильный способ указать заголовок авторизации с пользовательским типом, таким как ApiKey, в openAPI 3.

Пользовательский заголовок авторизации должен выглядеть как

Авторизация: ApiKey myAPIKeyHere

Все мои попытки указать запись securitySchemes с типом apiKey, похоже, дают другие результаты ...

Ближайшее, что я получил, это что-то вроде:

securitySchemes:
  ApiKeyAuth:
    type: apiKey
    in: header
    name: ApiKey

... но тогда ключ отсутствует в заголовке авторизации.

Как можно указать такое требование?

Answer 1

Я думаю, что нашел способ, который кажется приемлемым, хотя и не идеальным. Хотелось бы увидеть что-то лучшее в будущем ...

Кажется, что нет другого способа, кроме как добавить пользовательский тип к значению (с помощью описания, как показано ниже).

components:
  securitySchemes:
      ApiKey:
         type: apiKey
         name: Authorization
         in: header
         description: 'Prefix the value with \"ApiKey\" to indicate the custom authorization type' 
security:
   - ApiKey: []

Это по крайней мере дает правильный заголовок в curl (если применяется правильно).

Answer 2

Пожалуйста, попробуйте это:

  securitySchemes:
    ApiKeyAuth:
       type: apiKey
       in: header
       name: ApiKey
  security
    - ApiKeyAuth: []

Пожалуйста, ознакомьтесь с документацией:

-> Шаг 2. Применение безопасности

Аутентификация и авторизация