RESTful API 版本控制与 Kubernetes 入门
1. RESTful API 版本控制
1.1 API 版本控制策略
- 查询参数版本控制 :与 URI 版本控制类似,但版本信息作为查询参数而非路径参数。例如:
-
GET /api/account?version=1
-
GET /api/account?version=2
这种策略不需要客户端更改 URL,只需修改参数。 - 头部版本控制 :通过在请求头中添加表示 API 版本的信息,如:
-
GET /api/accounts Headers: { “X - API - version”: “1” }
-
GET /api/accounts Headers: { “X - API - version”: “2” }
此方法适合 REST 风格,且版本信息对用户是隐藏的。
1.2 版本控制最佳实践
- 采用三部分版本号 :版本号格式为
major.minor.patch
,例如1.3.2
,其中major
表示重大或有破坏性的 API 更改;minor
表示新增向后兼容的功能;