应该在RESTful API的URL中加入版本号,这样可以方便不同版本之间的区分和管理。在URL中加入版本号,可以采用以下两种方式:
https://api.example.com/v1/users
这样,在未来需要升级API版本时,可以在URL路径中加入新的版本号,例如:
https://api.example.com/v2/users
GET /users HTTP/1.1
Host: api.example.com
Accept: application/json
Api-Version: 1.0
这种方式可以让URL更简洁,但需要客户端在请求API时指定版本号。
需要注意的是,在URL中加入版本号时,应该遵循语义化版本控制规范,即版本号格式应该为MAJOR.MINOR.PATCH
,例如v1.0.0
,其中:
MAJOR
表示主版本号,表示API有不兼容的改动;MINOR
表示次版本号,表示API有向下兼容的功能增加;PATCH
表示修订号,表示API有向下兼容的问题修复。这样可以让API的使用者更好地理解版本号的含义,避免版本号混乱。