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

来源:http://www.cnblogs.com/wuqian1/archive/2017/04/28/6782163.html
-Advertisement-
Play Games

簡介 簡介 對於.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


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 以前簡單介紹過web api 的設計,但是還是有很多朋友問我,如何合理的設計和實現web api。比如,介面安全,異常處理,統一數據返回等問題。所以有必要系統的總結總結 web api 的設計和實現。由於前面已經介紹過web api 的參數和返回格式的設計,《Web API系列(一)設計經驗與總結》 ...
  • 一、前言 我們在優化Web服務的時候,對於靜態的資源文件,通常都是通過客戶端緩存、伺服器緩存、CDN緩存,這三種方式來緩解客戶端對於Web伺服器的連接請求壓力的。 本文指在這三個方面,在ASP.NET Core中靜態文件的實現過程和使用方法進行闡述。當然也可以考慮使用反向代理的方式(例如IIS或Ng ...
  • 這裡的“私闖sys.databases”是指Entity Framework預設發起的查詢:SELECT Count(*) FROM sys.databases WHERE [name]=N'資料庫名' 註:本文針對的是Entity Framework Code First場景,Entity Fra ...
  • 最近做一個指紋採集和比對的功能,因為公司整個項目是WEB類型的,所以指紋採集的模塊要嵌套在網頁中,那隻有用ActiveX了,以下是一些操作及效果,做個筆記! 新建用戶控制項,編寫CS代碼,如下: ? 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ...
  • Visual Studio 我們在Windows平臺上開發應用程式使用的工具主要是Visual Studio.這個集成開發環境已經演化了很多年,從一個簡單的C++編輯器和編譯器到一個高度集成、支持軟體開發整個生命周期的多語言環境。 Visual Studio以及它發佈的工具和服務提供了:設計、開發、 ...
  • 在開發Windows服務程式時,我們一般需要添加安裝程式,即:serviceInstaller,裡面有幾個關於名稱屬性,你都搞明白了嗎? 1.Description:表示服務說明(描述服務是乾什麼的); 2.DisplayName:表示友好名稱,可以理解為服務名的別名; 3.ServiceName: ...
  • 從編程的角度來講,ASP.NET Web API針對CORS的實現僅僅涉及到HttpConfiguration的擴展方法EnableCors和EnableCorsAttribute特性。但是整個CORS體系不限於此,在它們背後隱藏著一系列的類型,我們將會利用本章餘下的內容對此作全面講述,今天我們就來 ...
  • 為什麼要使用StringBuilder 為什麼要使用StringBuilder 為什麼要使用StringBuilder 為什麼使用StringBuilder要從string對象的特性說起。 為什麼使用StringBuilder要從string對象的特性說起。 string對象在進行字元串拼接時,因為 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...