发布版本化API客户端的最佳实践

时间:2016-04-03 02:33:20

标签: api rest api-design apiclient

我在Apiary.io上记录了NemeStats.com的版本化API:http://docs.nemestatsapiversion2.apiary.io/#

我将发布一个C#API客户端类库(在GitHub和NuGet上),但我正在试图弄清楚在我对API进行版本化时的最佳做法。我正在考虑的一些事情是:

  1. 发布一个新的API客户端,其版本清楚地表示在 名称。例如,NemeStatsApiVersion1Client vs. NemeStatsApiVersion2Client
  2. 保留相同的客户端,但为每个API添加备用版本方法 呼叫。例如,“usersClient.RegisterNewUserV1()”vs. “usersClient.RegisterNewUserV2()”等。
  3. 保留相同的客户端,但本身只有不同版本的(资源)类。 例如。 “UsersClientV1”与“UsersClientV2”。
  4. 以前有人这样做过吗?有什么提示吗?

0 个答案:

没有答案