Индивидуальный подход к заголовкам для версий REST API Spring Boot - PullRequest
Новая
       35

Индивидуальный подход к заголовкам для версий REST API Spring Boot

0 голосов
/ 12 января 2020

Я хочу реализовать Управление версиями REST API с помощью Spring Boot и Swagger с использованием пользовательских заголовков . Я прошел много ссылок, как показано ниже.

https://dzone.com/articles/versioning-rest-api-with-spring-boot-and-swagger

Spring + Springfox + Параметры заголовка

Добавить параметр заголовка в документацию по интерфейсу Swagger UI с Springfox

С одной стороны ясно, что каждая моя конечная точка REST должна быть помечена Пользовательским заголовком headers = {"X-API-VERSION=v1"}.

Ниже приведен мой пример конечных точек отдыха. . 

@ApiOperation(value = "Find Employees", nickname = "Find Employees")
@ApiResponses(value = { @ApiResponse(code = 200, message = "For Success as well as No Data found scenerio."),
        @ApiResponse(code = 500, message = "Internal Server Error") })
@GetMapping(value = "/employees", headers = {"X-API-VERSION=v1"})
public ResponseEntity<List<Employee>> findEmployees() {
    List<Employee> EmployeeList= employeeservice.findAllEmployees();
    return new ResponseEntity<List<Employee>>(EmployeeList,HttpStatus.OK);
}

Изменения / обновления Swagger Config 

@Configuration
@EnableSwagger2
public class SwaggerConfig{
    @Bean
    public Docket api() {
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder.name("X-API-VERSION=v1").modelRef(new ModelRef("string")).parameterType("header").required(true).build();
        List<Parameter> operationParameters = new ArrayList<>();
        operationParameters.add(aParameterBuilder.build());

        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(Predicates.not(RequestHandlerSelectors.basePackage("org.springframework.boot")))
                .apis(RequestHandlerSelectors.basePackage("com.example"))
                .paths(PathSelectors.any())
                .build()
                .apiInfo(apiInfo())
                .useDefaultResponseMessages(false)
                .globalOperationParameters(operationParameters)
                .globalResponseMessage(
                        RequestMethod.GET,
                        newArrayList(new ResponseMessageBuilder().code(500).message("").build()));
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API Management")
                .description("Sample Description")
                .termsOfServiceUrl("https://www.test.com")
                .version("0.1")
                .build();
    }
}

По этой ссылке: https://www.springboottutorial.com/spring-boot-versioning-for-rest-services, я должен передать значение X-API-VERSION=v1, но когда я прошло, что /employees/v1/error вызывается конечная точка, и ничего не осталось и ни один контроллер не вызывается. Как исправить эту проблему?

1 Ответ

1 голос
/ 12 января 2020

так работает этот подход. 

@RestController
public class TestController {


    @RequestMapping(value = "/user")
    public String getUserDefault() {
        return "getUserDefault";
    }

    @RequestMapping(value = "/user", headers = {"X-API-VERSION=v1"})
    public String getUserV1() {
        return "getUserV1";
    }

    @RequestMapping(value = "/user", headers = {"X-API-VERSION=v2"})
    public String getUserV2() {
        return "getUserV2";
    }

}

также вы можете использовать GetMapping вместо RequestMapping, давайте проверим его, используя curl: 

curl --location --request GET 'http://localhost:8080/user' --header 'X-API-VERSION: v2'

return 200 getUserV2

curl --location --request GET 'http://localhost:8080/user' --header 'X-API-VERSION: v1'

return 200 getUserV1

curl --location --request GET 'http://localhost:8080/user'

return 200 getUserDefault
...