Spring Boot REST API 版本控制的自定义标头方法

Posted 2023-03-28

【中文标题】Spring Boot REST API 版本控制的自定义标头方法

【英文标题】：Custom Header Approach for Spring Boot REST API versioning

【发布时间】：2020-04-29 05:47:02

【问题描述】：

我希望实现使用自定义标头使用 Spring Boot 和 Swagger 对 REST API 进行版本控制。我浏览了许多链接，如下所示。

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

Spring + Springfox + Header Parameters

Add a header parameter in Swagger UI documentation with Springfox

有一点很清楚，我的每个 REST 端点都必须用 Custom Header headers = "X-API-VERSION=v1" 进行注释。

以下是我的示例 Rest Endpoints。

@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 配置更改/更新

@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 时，端点将被调用，没有任何剩余，也没有调用控制器。如何解决这个问题？

【问题讨论】：

如果你从邮递员那里调用你的 api，它是否按照 Header 中指定的版本工作正常？

我不知道你在做什么，你期望发生什么，以及会发生什么。请准确。您发布了一个端点，映射到 /employees。 /employees/v1/error 有何相关性？

【参考方案1】：

这就是这种方法的工作原理。

@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

【讨论】：

看起来我们可以将 X-API-VERSION: v1 和 X-API-VERSION: v2 用于单个端点？

@PAA 是的，在这个例子中我使用了 3 次，v1，v2 并且没有版本标题

以使用 V2 为例，我们需要复制看起来的整个代码。我们不能在相同的代码下使用吗？

@Mojtabye- 如果客户端没有在请求中发送它，您知道我们如何将默认值设置为自定义标头吗？