2016-03-08 6 views
0

Я документирую API с Swagger, это первый раз, когда я использую Swagger. Когда я использую редактор swagger, я могу документировать и видеть, что я хочу видеть. Однако, когда я помещал один и тот же файл yaml в swagger ui, я не могу видеть определения безопасности. Может быть, я делаю что-то неправильно? или просто невозможно?Спецификации безопасности часов Swagger UI

securityDefinitions: 
    clientId: 
    type: apiKey 
    name: x_client_id 
    in: header 
    accessToken: 
    type: apiKey 
    name: access_token 
    in: header 
security: 
    - clientId: [] 
    - accessToken: [] 

И пример, где я использую

/auth/signup: 
    post: 
    description: register a user 
    security: 
    - accessToken: [] 
    parameters: 
     - name: User 
     in: body 
     required: true 
     schema: 
      $ref: '#/definitions/UserRequest' 
    responses: 
     200: 
     description: SuccessfulResponse 
     schema: 
      $ref: '#/definitions/AuthSuccessfulResponse' 
     400: 
     description: Error 
     schema: 
      $ref: '#/definitions/BadRequest' 

спасибо

ответ

1

В настоящее время да, определение безопасности не применяются динамически. Это будет разрешено через день или около того, когда https://github.com/swagger-api/swagger-ui/pull/2014 будет объединено.

Смежные вопросы