一、前言
1、版本的重要性
在RESTful 规范中,有关版本的问题,用restful规范做开放接口的时候,用户请求API,系统返回数据。但是难免在系统发展的过程中,不可避免的需要添加新的资源,或者修改现有资源。因此,改动升级必不可少,但是,作为平台开发者,应该知道:一旦你的API开放出去,有人开始用了,平台的任何改动都需要考虑对当前用户的影响。因此,做开放平台,从第一个API的设计就需要开始API的版本控制策略问题,API的版本控制策略就像是开放平台和平台用户之间的长期协议,其设计的好坏将直接决定用户是否使用该平台,或者说用户在使用之后是否会因为某次版本升级直接弃用该平台。
2、定义版本
怎么定义版本协议,前端后端怎么协调。有以下几种方式:
- 请求头中定义
GET /something/ HTTP/1.1
Host: example.com
Accept: application/json; version=1.0 #版本为1.0
- URL中定义
URL: example.com/v1.0/ # 版本为1.0
GET /1.0/something/ HTTP/1.1
Host: example.com
Accept: application/json
- 子域名中定义
GET /something/ HTTP/1.1
Host: v1.example.com
Accept: application/json
- HttpReqeust参数传递
GET /something/?version=0.1 HTTP/1.1
Host: example.com
Accept: application/json