Browse Source

Update rest-versioning.md

tags/2.0.16
崔亮 6 years ago committed by GitHub
parent
commit
33a9239cbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 13
      docs/guide-zh-CN/rest-versioning.md

13
docs/guide-zh-CN/rest-versioning.md

@ -1,9 +1,9 @@
版本
==========
一个好的 API 设计应该是“版本化”的: 变更和新的功能应该在 API 新版本中实现,而不是在一个版本上持续更改。与Web应用程序不同,您可以完全控制客户端和服务器端
一个好的 API 设计应该是“版本化”的变更和新的功能应该在 API 新版本中实现,而不是在一个版本上持续更改。与Web应用程序不同,您可以完全控制客户端和服务器端
代码,APIs 是为了给超出控制的客户端使用。因此,
应该尽可能的保持向后兼容性,如果有一些变化不能向后兼容,你应该在新版本的 API 中采用它同时增加版本号。现有客户端可以继续使用旧版本的API;新的或升级的客户端可以在新的API版本中获得新的功能。
应该尽可能的保持向后兼容性,如果有一些变化不能向后兼容,你应该在新版本的 API 中采用它同时增加版本号。现有客户端可以继续使用旧版本的 API;新的或升级的客户端可以在新的 API 版本中获得新的功能。
> Tip: 可以参考 [Semantic Versioning](http://semver.org/)
来获取更多关于设计 API 版本号的信息
@ -24,7 +24,7 @@ Accept: application/vnd.company.myapp-v1+json
这两种方法都有优点和缺点, 而且关于他们也有很多争论。
下面我们描述在一种 API 版本混合了这两种方法的一个实用的策略:
* 把每个主要版本的 API 实现在一个单独的模块 ID 的主版本号 (例如 `v1`, `v2`)。
* 把每个主要版本的 API 实现在一个单独的模块 ID 的主版本号 (例如 `v1`,`v2`)。
自然,API 的 url 将包含主要的版本号。
* 在每一个主要版本 (在相应的模块),使用 `Accept` HTTP 请求头
确定小版本号编写条件代码来响应相应的次要版本。
@ -97,11 +97,12 @@ return [
跨模块重用代码也是有可能的。
为了处理次要版本号, 可以利用内容协商
功能通过 [[yii\filters\ContentNegotiator|contentNegotiator]] 提供的行为。 `contentNegotiator` 行为可设置
功能通过 [[yii\filters\ContentNegotiator|contentNegotiator]] 提供的行为。
`contentNegotiator` 行为可设置
[[yii\web\Response::acceptParams]] 属性当它确定支持哪些内容类型时。
例如, 如果一个请求通过 `Accept: application/json; version=v1` 被发送,
内容交涉后,[[yii\web\Response::acceptParams]]将包含值`['version' => 'v1']`。
例如,如果一个请求通过 `Accept: application/json; version=v1` 被发送,
内容交涉后,[[yii\web\Response::acceptParams]] 将包含值 `['version' => 'v1']`
基于 `acceptParams` 的版本信息,你可以写条件代码
如 actions,resource classes,serializers 等等。

Loading…
Cancel
Save