Swagger+AutoRest

Swagger+AutoRest 生成web api客戶端(.Net)

 

簡介

對於.net來講，用web api來構建服務是一個不錯的選擇，都是http請求，調用簡單，可是若是真的要在程序中調用，則還有些工做要作，好比咱們須要手寫httpClient調用，並映射Model， 若是服務少還能夠，多了就繁瑣了。

Swagger

關於Swagger的信息，其餘博客已經有介紹，這裏就很少說。 你們能夠參考 http://chuansong.me/n/322685748559 ，使用Swagger後，能夠解決服務沒有文檔或者文檔和服務不一樣步的問題，同時Swagger自帶的就有模擬請求的功能，因此能夠在頁面上直接測試接口。 這些不只對開發，對測試同窗也是友好的。 

下面是一個簡單的Web API,添加註釋

 

引用swagger後，訪問http://XXX/swagger/ui/index(XXX爲你的域名)，結果以下，能夠看到頁面上會顯示你的服務，以及服務的描述。

 

 點擊具體某個服務，你能夠看到你定義的參數，並能夠直接在頁面上發起測試。 

AutoRest

有了Swagger後，方便查看服務，接下來就是如何調用服務，過往咱們一般會寫一個HttpUtils的類，裏面包含SendGet，SendPost兩個方法，若是是簡單參數還好，可是若是Get請求返回一個對象，或者Post的時候須要發送一個對象，則須要手寫這些類進行封裝。 這裏介紹一個組件:AutoRest ( https://github.com/Azure/AutoRest), 簡單來講，就是一個EXE工具，能夠根據Swagger的結構生成服務的客戶端，這個客戶端可讓你像調用本地方法同樣調用服務，方法內部包裝了Http請求。 

在Swagger頁面，你能夠點擊Explore按鈕，經過瀏覽器能夠看到這裏返回了一個Json字符串，頁面也是根據這個字符串進行的渲染，AutoRest也是根據這個結構來生成調用類。

 

選擇Nuget，下載AutoRest

在solution下面找到pageage文件夾，目錄以下：

在命令行裏面打開 ，輸入以下 AutoRest.exe -CodeGenerator CSharp -Modeler Swagger -Input http://XXX/swagger/docs/v1 -Namespace UserServiceClient, 其中Input的參數就是Swagger的Json地址，具體參數含義能夠查看文檔。 

執行成功後，在當前目錄下會生成一個Generated目錄

打開文件以下：

新建一個控制檯程序，將整個文件夾copy到控制檯程序下，文件夾名稱能夠隨意定義。

 

 

 同時控制檯程序須要在Nuget中引用一個Client. 

寫代碼，調用，同時支持同步接口和異步接口。 

至此，所有完成。 

總結

1. 以上這種方式，能夠由服務端的同窗完成，而後將生成的代碼，簡單修改後，編譯發佈到公司內nuget上，其餘同窗能夠直接到公司內nuget下載

2. 服務端同窗能夠只集成Swagger，而後其餘同窗若是要用，能夠經過工具生成。 

3. 以上僅是公司再未使用RPC前,方便服務調用的一種方式。 後面我會介紹一些.Net下的其餘的服務調用方式，好比Hession,serverstack

 

分類:  服務調用