Swagger Core 2.0 отключить безопасность для конечной точки - PullRequest
Новая
       8

Swagger Core 2.0 отключить безопасность для конечной точки

0 голосов
/ 01 июня 2018

Я использую Swagger Core 2.0 для генерации файлов определений openAPI 3.0 и
У меня проблемы с отключением «безопасности» для конкретной конечной точки.У меня определены мои securitySchemes и корневой элемент безопасности: 

{
  "openapi" : "3.0.1",
  "security" : [ {
    "JWT" : [ ]
  } ],
  "paths" : {   
    "/auth" : {
      "post" : {
        "summary" : "authenticate user",
        "operationId" : "authenticate",
        "requestBody" : {
          "content" : {
            "application/json" : {
              "schema" : {
                "$ref" : "#/components/schemas/AuthenticationRequest"
              }
            }
          }
        },
        "responses" : {
          "200" : {
            "description" : "when user is successfully authenticated",
            "content" : {
              "application/json" : {
                "schema" : {
                  "$ref" : "#/components/schemas/AuthenticateUserOutput"
                }
              }
            }
          },       
          "401" : {
            "description" : "when email/password not valid or user is blocked/inactive"
          }       
        }
      }
    },
  },
  "components" : {
    "schemas" : {
      "AuthenticateUserOutput" : {
        "type" : "object",
        "properties" : {
          "token" : {
            "type" : "string"
          },
          "lastLoginAt" : {
            "type" : "string",
            "format" : "date-time"
          },        
          "lastProjectId" : {
            "type" : "string"
          }
        }
      },
      ...,
      "AuthenticationRequest" : {
        "required" : [ "email", "password" ],
        "type" : "object",
        "properties" : {
          "email" : {
            "type" : "string"
          },
          "password" : {
            "type" : "string"
          }
        }
      }
    },
    "securitySchemes" : {
      "JWT" : {
        "type" : "http",
        "scheme" : "bearer",
        "bearerFormat" : "JWT"
      }
    }
  }
}

В соответствии со спецификацией OPEN API 3 https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#securityRequirementObject я смогу переопределить глобальное «требование безопасности» для отдельной операции.Я хотел бы «отключить» безопасность JWT для нескольких операций, и в соответствии с https://github.com/OAI/OpenAPI-Specification/blob/3.0.1/versions/3.0.1.md#securityRequirementObject это можно сделать:

Чтобы удалить объявление безопасности верхнего уровня, можно использовать пустой массив.

К сожалению, я пытаюсь определить «пустой массив безопасности» на уровне операций с помощью аннотаций ... Я пытался указать 

security = {}

или 

security = @SecurityRequirement(name ="")

но никакой элемент безопасности внутри операции не создается вообще .... Есть идеи?

Ниже приведен мой Java-код (я использую для интеграции Swagger DropWizard), который позволяет определить SecurityScheme и безопасность корневого уровня 

 Info info = new Info()
            .title("someTitle")
            .description("some description")
            .version("1.0")

    SecurityScheme jwtSecurity = new SecurityScheme()
            .type(SecurityScheme.Type.HTTP)
            .name("Authorization")
            .in(SecurityScheme.In.HEADER)
            .scheme("bearer")
            .bearerFormat("JWT");

    String securitySchemaName = "JWT";
    OpenAPI oas = new OpenAPI()
            .info(info)
            .components(new Components().addSecuritySchemes(securitySchemaName, jwtSecurity))
            .addSecurityItem(new SecurityRequirement().addList(securitySchemaName));

    SwaggerConfiguration oasConfig = new SwaggerConfiguration()
            .openAPI(oas)
            .prettyPrint(true)
            .resourcePackages(Stream.of("my.resources.package")
                    .collect(Collectors.toSet()));
    environment.jersey().register(new OpenApiResource()
            .openApiConfiguration(oasConfig));

Затем на нескольких выделенных конечных точках я хотел бы отключитьбезопасность, поэтому я пытаюсь с: 

    @POST
@Operation(
        summary = "authenticate user",
        responses = {
                @ApiResponse(responseCode = "200", description = "when user is successfully authenticated",
                        content = @Content(schema = @Schema(implementation = AuthenticateUserOutput.class))),                   
                @ApiResponse(responseCode = "401", description = "when email/password not valid or user is blocked/inactive"),
        }
        ,security = what to put here ?
)

1 Ответ

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

Согласно комментарию к проекту Спецификация OpenAPI GitHub .Это должно быть возможно.

Вы пробовали это? 

security: [
  {}
]
...