【发布时间】:2020-10-27 11:07:32
【问题描述】:
我需要使用 NodeJS 开发 API。但我不是 nodejs 专家。对于 API 的版本控制,我找到了一种方法,我们应该为 V1 和 V2 版本保留 2 个文件夹。这是我的 API 开发要遵循的最佳实践吗?请建议最好的方法?并建议项目结构。
提前致谢
【问题讨论】:
标签: node.js api versioning
我需要使用 NodeJS 开发 API。但我不是 nodejs 专家。对于 API 的版本控制,我找到了一种方法,我们应该为 V1 和 V2 版本保留 2 个文件夹。这是我的 API 开发要遵循的最佳实践吗?请建议最好的方法?并建议项目结构。
提前致谢
【问题讨论】:
标签: node.js api versioning
您应该将 API 版本保留为可配置的变量(例如在 .env 文件中)。然后,您可以通过将版本添加到根端点的路径(例如/my-api/v1/api-resource)来对 API 进行版本控制。当开发新版本的 API 时,只需将版本更改为 v2。
我认为两个不同目录的解决方案不好,因为你必须复制代码,它很快就会把事情搞砸。如果您想分离不同版本的 API,您应该使用某种类型的版本控制并在单独的分支上开发您的 v1(例如 v1),当该版本的开发完成时,只需创建一个新分支对于新版本(例如v2)。
您还应该将 REST 视为 API 的架构风格:https://restfulapi.net/
我还创建了一个基于 REST 架构的template for the development of backend systems in Node.js,因此您可以查看 Node.js 项目的目录结构和架构。
【讨论】: