asp.net mvc 集成swagger並漢化文檔

来源:https://www.cnblogs.com/kook2007/archive/2022/04/15/16151357.html
-Advertisement-
Play Games

之前用.net5.0寫webapi,自動集成swagger,非常方便。asp.net mvc沒有自動集成swagger,但是手動配置swagger也很簡單。 1、nuget引用Swashbuckle庫,安裝完後,App_Start下自動多了一個SwaggerConfig.cs; 2、打開Swagge ...


之前用.net5.0寫webapi,自動集成swagger,非常方便。asp.net mvc沒有自動集成swagger,但是手動配置swagger也很簡單。
1、nuget引用Swashbuckle庫,安裝完後,App_Start下自動多了一個SwaggerConfig.cs;
2、打開SwaggerConfing.cs,
c.SingleApiVersion("v1", "××系統API"); 這行是標記api的名字
c.IncludeXmlComments(GetXmlCommentsPath()); 這行是載入xml描述
c.CustomProvider((defaultProvider) => new SwaggerCacheProvider(defaultProvider, string.Format(@"{0}\bin\WRSServices.XML", System.AppDomain.CurrentDomain.BaseDirectory)));這行是漢化用的,這個provider里是按照類的summary和xml的member標記解析類,用於解析swagger的模型等,
c.InjectJavaScript(System.Reflection.Assembly.GetExecutingAssembly(), "×××.××.swagger_chs.js");這行是載入swagger漢化的js,js文件屬性改為嵌入式資源,js前面以namespace和js所在文件夾的位置為類名稱。

註意:
1、項目的屬性-【生成】,需要勾上XML文檔文件;
2、發佈時項目的XML文檔文件不會自動發佈,需要從bin里拷貝到發佈後文件中;
3、要想響應類模型有解析,需要在api方法前加上ResponseType特性,如:
[ResponseType(typeof(×××.×××.ClassName))]
4、api的控制器中不要有泛型類,否則,編譯成功,但swagger頁面會報錯,因為swagger是一開始就需要明確類型,泛型是運行時才知道真是類型,如果需要通過泛型去做一些模式重構的話,可以把泛型的方法單獨拎出來,放到helper或公共類里。

SwaggerCacheProvider和swagger的漢化js,網上很多。比如:https://blog.csdn.net/qq_25405005/article/details/89384555

本文來自博客園,作者:GIS民工,轉載請註明原文鏈接:https://www.cnblogs.com/kook2007/p/16151357.html


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

-Advertisement-
Play Games
更多相關文章
  • 來源:zzzgd.blog.csdn.net/article/details/80627175 1. 前言 poi框架可以支持我們在java代碼中, 將數據導出成excel,但是實際開發中, 往往還需要設置excel字體,顏色,行高,列寬等屬性, 有時候還需要鎖住單元格, 防止別人講數據隨意篡改. ...
  • 一、源碼執行時的先後順序: 父類的靜態屬性和靜態塊(按照聲明順序) 本類的靜態屬性和靜態塊(按照聲明順序) main方法 父類的成員屬性和成員塊(按照聲明順序) 父類構造器 本類成員屬性和塊(按照聲明順序) 本類構造器 二、源碼執行需要註意: 在類載入的時候,靜態方法也已經載入了,但必須要通過類名或 ...
  • 前言 天氣預報我們每天都會關註,我們可以根據未來的天氣增減衣物、安排出行,每天的氣溫、風速風向、相對濕度、空氣質量等成 為關註的焦點。本次使用python中requests和BeautifulSoup庫對中國天氣網當天和未來14天的數據進行爬取,保存為csv文件,之 後用matplotlib、num ...
  • 大家平時都會用到哪些可視化的工具呢?Python中又有哪些好用的可視化模塊呢?今天就給大家分享一個Python小技能,小白也 能學會的可視化教程。 正 文 今天小編總結歸納了若幹個常用的可視化圖表,並且通過調用plotly、matplotlib、altair、bokeh和seaborn等模塊來分 別 ...
  • 最近在工作中面向社群玩家組織了一場活動,需要進行隨機抽獎,參考之前小明大佬的案例,再結合自己的需求,做了一個簡單的隨機抽獎小工具。 今天我就來順便介紹一下這個小工具的製作過程吧! 1. 核心功能設計 針對隨機抽獎的小工具,需要可以導入參與抽獎的人員名單,然後選擇不同的獎勵類型進行隨機抽取獲獎名單並導 ...
  • 大家在Debug程式的時候,是否遇到過因為“下一步”按太快,而導致跳過了想要深入分析的那段代碼?是不是很想要有“回到上一步”這樣的操作呢? 在IDEA中就提供了一個幫助你回退代碼的機會,但這個方法並不是萬能的。好了,下麵就來具體說說這個功能的使用! 使用Reset Frame回退操作 不知道你在De ...
  • 修飾類只有public和default(也就是是不寫訪問修飾符) 修飾成員變數或成員方法時有四種 public 可以被任意包中的類訪問 protected 可以被同一包下的其他類訪問(包括同一包下的子類),其他包的子類可以訪問 default(也就是什麼都不寫) 可以被同一包下的其他類訪問(包括同一 ...
  • 來源:juejin.im/post/5d026212f265da1b8608828b IDEA是Java開發利器,springboot是Java生態中最流行的微服務框架,docker是時下最火的容器技術,那麼它們結合在一起會產生什麼化學反應呢? 一、開發前準備 1.Docker安裝 可以參考: ht ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...