Как добавить http basic аутентификацию в swagger?

Пользователь

от amber_moore , в категории: Другие , 7 месяцев назад

Как добавить http basic аутентификацию в swagger?

Facebook Vk Ok Twitter LinkedIn Telegram Whatsapp

1 ответ

Пользователь

от dan_farrell , 7 месяцев назад

@amber_moore 

Swagger позволяет добавлять HTTP Basic аутентификацию к вашей документации API. Чтобы добавить HTTP Basic аутентификацию в Swagger, вам нужно выполнить следующие шаги:

  1. Определите схему безопасности для HTTP Basic аутентификации в вашем Swagger-файле. Вот пример определения схемы безопасности для HTTP Basic:
1
2
3
4
securityDefinitions:
  basicAuth:
    type: basic
    description: HTTP Basic Authentication.


  1. Добавьте схему безопасности к определению маршрута, который должен быть защищен. Вот пример определения маршрута, который защищен HTTP Basic:
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
paths:
  /users:
    get:
      security:
        - basicAuth: []
      summary: Returns a list of users.
      description: Optional extended description in CommonMark or HTML.
      responses:
        '200':
          description: OK


В этом примере схема безопасности basicAuth связывается с определением маршрута /users метода GET. Обратите внимание, что массив security содержит объект basicAuth, который указывает на то, что маршрут должен быть защищен HTTP Basic аутентификацией.

  1. После добавления схемы безопасности и связывания ее с определением маршрута, Swagger будет отображать соответствующее поле в интерфейсе API, в котором пользователи могут ввести свои учетные данные.


Вот как это выглядит в интерфейсе Swagger:


HTTP Basic Authentication in Swagger


После ввода корректных учетных данных, Swagger добавит заголовок Authorization в запросы, отправленные к защищенному маршруту. Этот заголовок содержит информацию об авторизации, необходимую для прохождения аутентификации на стороне сервера.