.net怎麼使用Swagger

来源:https://www.cnblogs.com/txlit/archive/2019/09/17/11533676.html
-Advertisement-
Play Games

目錄導航 一、安裝 二、配置 三、調用 四、錯誤記錄 一、安裝 新建一個沒有身份驗證的mvc項目 - SwaggerMvc5Demo,然後添加一個名為Remote(自定義)且包含基礎讀寫(不想手寫)的ApiController 開源地址:https://github.com/domaindriven ...


 

目錄導航

一、安裝

新建一個沒有身份驗證的mvc項目 - SwaggerMvc5Demo,然後添加一個名為Remote(自定義)且包含基礎讀寫(不想手寫)的ApiController   開源地址:https://github.com/domaindrivendev/Swashbuckle 使用以下方法來添加 Swashbuckle:
  • 從“程式包管理器控制台”視窗:Install-Package Swashbuckle -Version 5.6.0
  • 從“管理 NuGet 程式包”對話框中:
  • 右鍵單擊“解決方案資源管理器” > “管理 NuGet 包”中的項目
  • 將“包源”設置為“nuget.org”
  • 在搜索框中輸入“Swashbuckle”
  • 從“瀏覽”選項卡中選擇“Swashbuckle”包,然後單擊“安裝”
 

二、配置

1.項目屬性->勾選生成xml文檔文件 2.添加導航鏈接 在_Layout.cshtml文件中添加代碼 <li>@Html.ActionLink("Swagger Help", "", "Swagger", new { area = "" }, null)</li> 3.修改SwaggerConfig.cs文件  安裝完成後,在文件夾App_Start自動生成一個配置文件 swagger.config。這裡可以做多版本控制,定義擴展功能,自定義顯示ui的樣式腳本,可以配置過濾、許可權等。 例如: (1)為介面添加xml註釋 string path = string.Format("{0}/bin/SwaggerMvc5Demo.XML", System.AppDomain.CurrentDomain.BaseDirectory); c.IncludeXmlComments(path); 使用前 使用後 (2)使用特性 [Obsolete] 在config中 開啟 c.IgnoreObsoleteProperties();        

三、調用

1.直接調用 只要輸入參數id,即可調用,非常方便 2.AutoRest AutoRest (https://github.com/Azure/AutoRest), 簡單來說,就是一個EXE工具,可以根據Swagger的結構生成服務的客戶端,這個客戶端可以讓你像調用本地方法一樣調用服務,方法內部包裝了Http請求。  詳細教程請看 https://www.cnblogs.com/Leo_wl/p/5982882.html   擴展:ABP集成swagger http://www.cnblogs.com/wer-ltm/p/5776024.html    

四、錯誤記錄

swagger出現問題:not supported by swagger 2.0

一個controller中只能有一個HttpGet請求,多了就會報錯。建議減少重載方法,將其他Get方法分開

如果在swagger.config中加上c.ResolveConflictingActions(apiDescriptions => apiDescriptions.FirstOrDefault());則會只顯示第一個get方法 

原文:https://blog.csdn.net/jin80506/article/details/77737470


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

-Advertisement-
Play Games
更多相關文章
  • 1、需求分析 用winform窗體程式,開發一個能夠自動、批量對圖片進行縮放和裁剪的程式。 原本想直接從網上找類型的工具直接用,但是無奈現在網上能找到的工具,要麼不能用,要麼就是很 噁心的下載完後還有一堆插件的,要麼就是我用不來的。 這個程式是我根據個人需求,想要把所有拍好的人像照,直接批處理成1寸 ...
  • 需要命名空間 using System.Net; using System.Net.Security using System.Security.Cryptography.X509Certificates; using System.Web.Script.Serialization; using N ...
  • 場景 FastReport安裝包下載、安裝、去除使用限制以及工具箱中添加控制項: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100893794 Winform中使用FastReport實現簡單的自定義PDF導出: https:/ ...
  • 場景 FastReport安裝包下載、安裝、去除使用限制以及工具箱中添加控制項: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100893794 Winform中使用FastReport實現簡單的自定義PDF導出: https:/ ...
  • using System.Xml; //引入命名空間 //模擬介面返回的數據 string str=@"<JZD_Message xmlns:xsd=""http://www.w3.org/2001/XMLSchema"" xmlns:xsi=""http://www.w3.org/2001/XML ...
  • 屬性(Property)是類(class)、結構(structure)和介面(interface)的命名(named)成員。類或結構中的成員變數或方法稱為 域(Field)。屬性(Property)是域(Field)的擴展,且可使用相同的語法來訪問。它們使用 訪問器(accessors) 讓私有域的 ...
  • 場景 Winform中使用FastReport實現簡單的自定義PDF導出: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100920681 在上面已經實現自定義PDF並導出的基礎上,實現導出或者列印前的預覽。 實現 在窗體中拖拽 ...
  • 下拉刷新: html: js: 無限滾動: html: js: 解釋: 如有問題,歡迎留言 ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...