Отображать заголовок авторизации при входе в API - PullRequest
Новая
       35

Отображать заголовок авторизации при входе в API

0 голосов
/ 02 июля 2019

Я использую OpenApi для документирования API, у меня есть путь / Логин, который позволяет мне указать имя пользователя и пароль в качестве параметров и возвращает JWT в стиле носителя в заголовке «авторизации» в ответе.

Для дальнейшего использования в API этот JWT используется с механизмом «Авторизация», чтобы можно было получить доступ к другим путям.

К сожалению, заголовок авторизации виден только если я открою трассировку сети в моем браузере.

Поэтому мой вопрос, могу ли я каким-то образом настроить мой OpenAPI YAML, чтобы значение отображалось и затем можно было скопировать / вставить в авторизацию для остальной части API.Я использую последний редактор Swagger (https://editor.swagger.io/)

Это то, что я указал 

paths:
  /Login:
    post:
      servers: 
        - url: ....
          description: Local test server
      tags:
      - Login
      summary: Logs into the API and returns the authorization.
      description: Username and Password are passed in header
      security: []
      #- bearerAuth: []
      parameters:  
      - $ref: '#/components/parameters/Username'
      - $ref: '#/components/parameters/Password'
      responses:
        200:
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Login'
          headers:
            authorization:
              $ref: '#/components/headers/authorization'
parameters:
    Username:
      name: Username
      in: header
      description: Username to authorize with
      schema:
        type: string
    Password:
      name: Password
      in: header
      description: Password to authorize with
      schema:
        type: string

  headers:
    authorization:
      schema:
        type: string
      description: Authorization token.
...