簡介 簡介 對於.net來說,用web api來構建服務是一個不錯的選擇,都是http請求,調用簡單,但是如果真的要在程式中調用,則還有些工作要做,比如我們需要手寫httpClient調用,並映射Model, 如果服務少還可以,多了就繁瑣了。 Swagger Swagger 關於Swagger的信息 ...
簡介
對於.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參考頁面:http://qingqingquege.cnblogs.com/p/5933752.html