spring - Spring Boot REST API 版本控制的自定义标头方法
问题描述
我正在寻找使用 Spring Boot 和 Swagger 使用 Custom Headers 来实现 REST API 的版本控制。我浏览了许多链接,如下所示。
https://dzone.com/articles/versioning-rest-api-with-spring-boot-and-swagger
Spring + Springfox + Header 参数
使用 Springfox 在 Swagger UI 文档中添加标头参数
有一件事看起来很清楚,我的每个 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,我必须传递 value X-API-VERSION=v1
,但是当我通过该/employees/v1/error
端点时,将被调用并且什么都没有留下,也没有控制器正在获取叫。如何解决这个问题?
解决方案
这就是这种方法的工作原理。
@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
推荐阅读
- ios - 如何在 navigationController 堆栈上使用多个 viewController 弹出ToRootViewController 并仅显示一个转换?
- python-3.x - 从列表中迭代采样,直到满足条件 - Python
- php - 通过从另一个表 laravel 中检索值来为表添加值
- swift - Swift,带有完成处理程序的网络调用不起作用
- c++ - 错误:无法将“float*”转换为“float”作为回报
- oracle - 当视图用于显示 Oracle Apex 中的现有记录时,如何在表中更新或创建新记录?
- python - 如何从嵌套列表中按 IP 地址提取端口
- mysql - sql 对 USERS 销售额求和
- django - Django elasticsearch DSL DRF 建议问题
- reactjs - Algolia instasearch 设计,如 reactjs.org 上的点击量 - reactjs