webapi 集成swagger

来源:https://www.cnblogs.com/dawenyang/archive/2019/05/23/10911051.html
-Advertisement-
Play Games

參考資料:Stack Overflow 我自己寫的demo:SwaggerDemoApi 在已有的webapi項目或者創建webapi項目中,打開nuget管理器 搜索:swagger 安裝截圖中的插件到你的webapi項目中 ,安裝完成後,項目根目錄下也可能會出現SwaggerNet.cs文件,把 ...


參考資料:Stack Overflow

我自己寫的demo:SwaggerDemoApi

在已有的webapi項目或者創建webapi項目中,打開nuget管理器

搜索:swagger

安裝截圖中的插件到你的webapi項目中 ,安裝完成後,項目根目錄下也可能會出現SwaggerNet.cs文件,把這個文件刪除掉即可

 

 這個插件是自動安裝的,依賴於Swagger.Net.UI

安裝完成之後,發現項目根目錄--App_Start目錄下回產生兩個文件

打開SwaggerNet.cs文件,把我截圖中的代碼註釋掉,不然會報錯,報錯信息:程式集“Swagger.Net, Version=0.5.1.0, Culture=neutral, PublicKeyToken=null”中的類型“Swagger.Net.XmlCommentDocumentationProvider”的方法“GetDocumentation”沒有實現。

 把圖中代碼註釋掉,就沒有報錯了。

運行起來後,在地址欄後加上/swagger,就可以自動跳轉到對應的頁面了。

 

集成到項目中報錯:Not supported by Swagger 2.0: Multiple operations with path 'api/Blob' and method 'POST'. See the config setting - \"ResolveConflictingActions\" for a potential workaround

參考資料:Not supported by Swagger 2.0: Multiple operations with path

                 webapi 配置swagger出現問題:not supported by swagger 2.0

在代碼

GlobalConfiguration.Configuration 
                .EnableSwagger(c =>
                    { ...

裡面加上一句:

c.ResolveConflictingActions(apiDescriptions => apiDescriptions.ToList().First());

或者

c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());

哪個不報錯就用哪個,自己看情況。加上之後就不報這個錯誤了,就成功的運行出來了。

 

2019.05.24 補充:

如何生成註釋文檔?參考資料:代碼註釋生成

 


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

-Advertisement-
Play Games
更多相關文章
  • 提示:基於官方教程 1.使用以下代碼在 Models 文件夾中創建一個名為 SeedData 的新類: using Microsoft.EntityFrameworkCore;using Microsoft.Extensions.DependencyInjection;using System;us ...
  • 問題 部署項目時,常常需要根據不同的環境使用不同的配置文件。例如,在部署網站時可能希望禁用調試選項,並更改連接字元串以使其指向不同的資料庫。在創建 Web 項目時,Visual Studio 自動生成了 Web.config、Web.Debug.config、Web.release.config這3 ...
  • 提示:基於官方教程整理 右鍵單擊“RazorPagesMovie”項目 >“添加” > “新建文件夾”。 將文件夾命名為“Models”。右鍵單擊“Models”文件夾。 選擇“添加” > “類”。 將類命名“Movie”。向 Movie 類添加以下屬性: using System;using Sy ...
  • 引入Nuget的兩個類庫 使用 ...
  • 1、把Configure中的 app.UseCookiePolicy(); 這一行代碼註釋掉 2、 /// <summary> /// 設置本地cookie /// </summary> /// <param name="key">鍵</param> /// <param name="value"> ...
  • 在Startup.cs 的 ConfigureServices中添加Session中間件設置 在Startup.cs 的 Configure中添加Session服務 引入命名空間 using Microsoft.AspNetCore.Http; 使用 HttpContext.Session.SetS ...
  • 增加mysql版本線上預覽地址:http://www.eipflow.com:3000/ ...
  • 以上是虛方法和多態。 面向對象編程過程中儘量依賴抽象的類,而不要過分依賴具體類。 基類的引用可以指向派生類。通過指向Dog類的Pet類的引用,僅能訪問Dog中繼承自Pet的部分,如下: ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...