Глобальный набор параметров с использованием конфигураций Open API? - PullRequest
Новая
       7

Глобальный набор параметров с использованием конфигураций Open API?

2 голосов
/ 31 января 2020

Я использую Spring Boot REST OpenAPI 3 спецификацию. В этом примере я хочу установить глобальные заголовки (Custom-Header-Version=v1), которые я хочу передать при выполнении запроса к каждой конечной точке (точкам).

Теперь проблема в том, что у меня 100 конечной точки REST , и для каждой конечной точки мне нужно постоянно добавлять @Parameter(in = ParameterIn.HEADER ....., эту конфигурацию, вместо этого я хотел установить ее глобально. Есть ли способ, если мы можем сделать это в OpenAPI?

Есть ли способ удалить SmartBear lo go из Spring do c ui? 

@RestController
@RequestMapping("/api")
@Tag(name = "contact", description = "the Contact API")
public class HelloController {

    @Operation(summary = "Find Contacts by name", description = "Name search by %name% format", tags = {"contact"})
    @ApiResponses(value = {
            @ApiResponse(responseCode = "200", description = "successful operation", content = @Content(array = @ArraySchema(schema = @Schema(implementation = PersonDTO.class))))})
    @Parameter(in = ParameterIn.HEADER, description = "Custom Header To be Pass", name = "Accept-version"
            , content = @Content(schema = @Schema(type = "string", defaultValue = "v1", allowableValues = {"v1"}, implementation = PersonDTO.class)))
    @GetMapping(value = "/contacts", headers = {"Custom-Header-Version=v1"})
    public ResponseEntity<List<PersonDTO>> findAll(
            @Parameter(description = "Page number, default is 1") @RequestParam(value = "page", defaultValue = "1") int pageNumber,
            @Parameter(description = "Name of the contact for search.") @RequestParam(required = false) String name) {

            return null;
        }
}

Ответы [ 2 ]

3 голосов
/ 06 марта 2020

вы можете попробовать следующий код. Добавлен .example ("v1") в коде, указанном выше как ouled saber

@Component
public class GlobalHeaderOperationCustomizer implements OperationCustomizer {
    @Override
    public Operation customize(Operation operation, HandlerMethod handlerMethod) {

        Parameter customHeaderVersion = new Parameter().in(ParameterIn.HEADER.toString()).name("Custom-Header-Version")
                .description("Custom Header Version)").schema(new StringSchema()).example("v1").required(false);

        operation.addParametersItem(customHeaderVersion);       
        return operation;
    }

У меня такое же требование, и по чванству я получаю как ниже

Изображение из чванства щ

3 голосов
/ 01 февраля 2020

Вы можете просто определить OperationCustomizer. 

@Component
public class GlobalHeaderOperationCustomizer implements OperationCustomizer {
    @Override
    public Operation customize(Operation operation, HandlerMethod handlerMethod) {
        Parameter parameterHeader = new Parameter()
                .in(ParameterIn.HEADER.toString())
                .schema(new StringSchema().addEnumItem("v1")._default("v1").name("Accept-version"))
                .description("Custom Header To be Pass");;
        operation.addParametersItem(parameterHeader);
        return operation;
    }
}
...