API版本控制的方式有哪些

這篇文章主要介紹“API版本控制的方式有哪些”，在日常操作中，相信很多人在API版本控制的方式有哪些問題上存在疑惑，小編查閱了各式資料，整理出簡(jiǎn)單好用的操作方法，希望對(duì)大家解答”API版本控制的方式有哪些”的疑惑有所幫助！接下來，請(qǐng)跟著小編一起來學(xué)習(xí)吧！

10年積累的成都網(wǎng)站設(shè)計(jì)、成都網(wǎng)站建設(shè)經(jīng)驗(yàn)，可以快速應(yīng)對(duì)客戶對(duì)網(wǎng)站的新想法和需求。提供各種問題對(duì)應(yīng)的解決方案。讓選擇我們的客戶得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識(shí)你，你也不認(rèn)識(shí)我。但先網(wǎng)站設(shè)計(jì)制作后付款的網(wǎng)站建設(shè)流程，更有鷹潭免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。

通過子域名（或子目錄）

第一個(gè)辦法，是直接使用兩個(gè)模塊（或者應(yīng)用）來實(shí)現(xiàn)，對(duì)于架構(gòu)改變比較大的API版本（尤其是不同版本之間基本沒法共用、更改框架甚至采用不同的語言實(shí)現(xiàn)）通常會(huì)這樣選擇。

目錄結(jié)構(gòu)如下：

api
├─application           
│  ├─v1  
│  │  ├─controller 
│  │  ├─model 
│  │  ├─config
│  │  └─ ...            
│  ├─v2
│  │  ├─controller
│  │  ├─model           
│  │  ├─config  
│  │  └─ ...     
│   ...

請(qǐng)求方式

GET https://api.tp5.com/v1/user/1
GET https://api.tp5.com/v2/user/1

當(dāng)然，你也可以通過子域名綁定模塊實(shí)現(xiàn)下面的方式訪問

GET https://v1.api.tp5.com/user/1
GET https://v2.api.tp5.com/user/1

通過請(qǐng)求參數(shù)

對(duì)于剛開始沒有做好版本規(guī)劃，后期迭代維護(hù)過程中增加了新的版本，考慮到架構(gòu)的改造成本，可能會(huì)考慮下面的方式：

GET https://api.tp5.com/user/1
GET https://api.tp5.com/user/1?version=v2

由于缺乏很好的路徑和類庫目錄規(guī)范，如果頻繁更新版本的話，建議把版本的架構(gòu)設(shè)計(jì)升級(jí)成后面的兩種方式。

通過路由

可能大多數(shù)接口在設(shè)計(jì)的時(shí)候已經(jīng)考慮到了版本控制的問題，那么通常會(huì)選擇在URL地址中增加版本標(biāo)識(shí)參數(shù)，這種方式便于調(diào)試。

對(duì)于API應(yīng)用來說，更建議采用單模塊設(shè)計(jì)+多級(jí)控制器，目錄結(jié)構(gòu)如下：

api
├─application          
│  ├─controller
│  │  ├─v1
│  │  ├─v2
│  │  └─ ...            
│  ├─model
│   ...

路由規(guī)則定義如下：

Route::get(':version/user/:id',':version.User/read');

GET https://api.tp5.com/v1/user/1
GET https://api.tp5.com/v2/user/1

由于使用了多級(jí)控制器，需要注意控制器的命名空間。

通過命令行可以快速的創(chuàng)建控制器文件：

php think make:controller v1/User

通過頭信息

最新的規(guī)范趨向于通過頭信息來定義版本，優(yōu)勢(shì)在于從歷史版本迭代更新的時(shí)候不需要改變URL地址，改變請(qǐng)求頭信息即可，主要分為兩種。

第一種是使用自定義請(qǐng)求頭例如api-version控制版本（同理你還可以用其它頭信息控制其它）

GET https://api.tp5.com/user/1
api-version:v2

頭信息的方式，路由規(guī)則的定義略微做下調(diào)整即可：

use think\facade\Request;
use think\facade\Route;

$version = Request::header('api-version') ? : 'v1';
Route::get('user/:id', $version . '.User/read');

也有很多采用了Accept頭信息來處理（好處是可以設(shè)置接口輸出格式），通常的規(guī)范是

GET https://api.tp5.com/user/1
Accept: application/vnd.tp5.v2+json

總結(jié)

對(duì)于API接口開發(fā)，盡量事先做好版本控制規(guī)劃，確保你的應(yīng)用能兼容新老版本的訪問。

我的小結(jié)：

版本號(hào)通過header中的api-version參數(shù)傳遞，然后通過路由來控制訪問到具體的控制器和方法

以下是我自己配置的路由：

注意配置路由的時(shí)候，“.”分割表示目錄名

表示當(dāng)請(qǐng)求api/任意控制器名/任意方法名時(shí)，會(huì)訪問api/版本目錄/任意控制器名/任意方法名

具體的路由規(guī)則還是要看官方文檔

到此，關(guān)于“API版本控制的方式有哪些”的學(xué)習(xí)就結(jié)束了，希望能夠解決大家的疑惑。理論與實(shí)踐的搭配能更好的幫助大家學(xué)習(xí)，快去試試吧！若想繼續(xù)學(xué)習(xí)更多相關(guān)知識(shí)，請(qǐng)繼續(xù)關(guān)注創(chuàng)新互聯(lián)網(wǎng)站，小編會(huì)繼續(xù)努力為大家?guī)砀鄬?shí)用的文章！

分享名稱：API版本控制的方式有哪些
本文網(wǎng)址：http://muchs.cn/article30/ghcppo.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供網(wǎng)站策劃、品牌網(wǎng)站制作、云服務(wù)器、網(wǎng)站收錄、網(wǎng)站營銷、域名注冊(cè)

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來源： 創(chuàng)新互聯(lián)