作者:chszs,轉(zhuǎn)載需注明。博客主頁:http://blog.csdn.net/chszs
在設(shè)計(jì)和構(gòu)建API時(shí),API的版本控制是非常重要的。
必須確保新API對于現(xiàn)有的API不會(huì)造成破壞。
首先,也是最重要的,可以把版本號(hào)放入API的URL中。這樣可以把主要版本更新放入API。比如,我們在調(diào)用CHUser Center API時(shí),可以在URL中使用/api-v1或/api-v2來指出所使用的API版本。這是很常見的做法。
在API版本控制中,還有一點(diǎn)也很重要。希望API能支持次要版本的更新。次要版本更新所造成的變化仍然會(huì)影響接口,因此有可能會(huì)影響當(dāng)前API的使用者,但它們與主版本的URL和API的基本功能都在變化不同,URL和API基本功能仍然是相同的。比如在CHUser Center API,次要版本的修改是通過客戶在API調(diào)用時(shí)發(fā)起請求的HTTP頭部做指定的。
作者:chszs,轉(zhuǎn)載需注明。博客主頁:http://blog.csdn.net/chszs
頭部的版本元素看起來是這樣的:
Element-Version: 1我們決定把JSON字段中的firstN改成firstName。很顯然,這只是一個(gè)小改動(dòng),所以它屬于API次要版本更新的范疇,無須做主版本的修改和不同的URL簽名。因此,我們會(huì)創(chuàng)建另一個(gè)GET /people接口,要調(diào)用它還需要在HTTP頭部加上
Element-Version: 2
然后就會(huì)返回以下JSON數(shù)據(jù):
聯(lián)系客服