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

Question

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

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

弹簧 + 弹簧狐 + 标头参数

使用 Springfox 在 Swagger UI 文档中添加标头参数

有一件事看起来很清楚，我的每个 REST 端点都必须使用自定义标头headers = {"X-API-VERSION=v1"}进行注释。

下面是我的示例 Rest 终结点。

@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);
}

招摇配置更改/更新

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

Answer 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