路由 api/v1 中额外的 /v1 的用途是什么

Question

为什么不让你的后端 api 路由以 开头/api呢？

为什么我们想要拥有这/v1一点？为什么不只是api/？你能举一个具体的例子吗？两者有何好处？

Answer 1

围绕公开服务的主要挑战之一是处理 API 合约的更新。当 API 发生变化时，客户可能不想更新他们的应用程序，因此版本控制策略变得至关重要。版本控制策略允许客户继续使用现有的 REST API，并在准备好时将其应用程序迁移到更新的 API。

有四种常见的 REST API 版本控制方法。

1. 通过 URI 路径进行版本控制 http://www.example.com/api/1/products

通过 URI 路径进行 REST API 版本控制 对 REST API 进行版本控制的一种方法是将版本号包含在 URI 路径中。

xMatters 使用这种策略，Facebook、Twitter、Airbnb 等的 DevOps 团队也是如此。

API的内部版本使用1.2.3格式，因此如下所示：

主要.次要.补丁

主要版本：URI 中使用的版本，表示对 API 的重大更改。在内部，新的主要版本意味着创建新的 API，并且版本号用于路由到正确的主机。次要版本和补丁版本：这些对客户端是透明的，并在内部用于向后兼容的更新。它们通常在更改日志中传达，以通知客户新功能或错误修复。此解决方案通常使用 URI 路由来指向特定版本的 API。由于缓存键（在这种情况下为 URI）会根据版本而更改，因此客户端可以轻松缓存资源。当 REST API 的新版本发布时，它被视为缓存中的新条目。

优点：客户端可以轻松缓存资源缺点：该解决方案在代码库中占用相当大的空间，因为引入重大更改意味着对整个 API 进行分支

参考： https: //www.xmatters.com/blog/blog-four-rest-api-versioning-strategies/# :~:text=Clients%20may%20not%20want%20to,API%20when%20they%20are% 20准备好了。