向net core 3.0進擊——Swagger的改變

来源:https://www.cnblogs.com/AprilBlank/archive/2019/10/08/11633522.html

[toc] 前言 十一小長假在不知不覺間可都沒了,在這個小尾巴的空隙,把這兩天鼓搗的net core 3.0升級過程記錄一下,首先還是根據之前的順序一個個補充進來,先從Swagger的變化說起(新建工程什麼的不多說了,就是選擇的時候選3.0就可以了,2019新版更新後創建預設都是3.0)。 引入 按 ...


前言

十一小長假在不知不覺間可都沒了,在這個小尾巴的空隙,把這兩天鼓搗的net core 3.0升級過程記錄一下,首先還是根據之前的順序一個個補充進來,先從Swagger的變化說起(新建工程什麼的不多說了,就是選擇的時候選3.0就可以了,2019新版更新後創建預設都是3.0)。

引入

按之前的習慣,對於引入我是不會多說,一個鏈接(我自己之前引入那些截圖)就給大家了,但是因為3.0屬於比較新的版本,所以在引入的時候,有些註意點還是要標註下的。
引入

在3.0中,我們會在Startup這裡發現,Mvc沒了統一替換成Controllers,當然這並不影響我們使用,但是最關鍵的,我們用來實驗的Values木得了,取而代之的是一個挺不錯的api的WeatherForecast介面

引入之後,我們還複製我們之前的swagger配置內容來試試,會發現新版也針對類名,屬性做了雪微的調整,這裡直接一張圖就可以看到。
引入

            #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1.1.0",
                    Title = "ERP WebAPI",
                    Description = "後臺框架",
                    Contact = new OpenApiContact() { Name = "Blank", Email = "[email protected]", Url = new Uri("https://www.cnblogs.com/AprilBlank/") }
                });
            });
            #endregion 

在使用註冊引用的地方倒是沒有變化。
引入

            #region Swagger
            app.UseSwagger();
            app.UseSwaggerUI(options =>
            {
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
                //如果設置根目錄為swagger,將此值置空
                options.RoutePrefix = string.Empty;
            });
            #endregion

註釋這次也一步到位,當然也是沒有太大的區別的。
首先,我們來生成xml文件。
生成

然後,我們直接複製之前的配置內容即可。
生成

            #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1.1.0",
                    Title = "ERP WebAPI",
                    Description = "後臺框架",
                    Contact = new OpenApiContact() { Name = "Blank", Email = "[email protected]", Url = new Uri("https://www.cnblogs.com/AprilBlank/") }
                });
                // 為 Swagger JSON and UI設置xml文檔註釋路徑
                var basePath = Path.GetDirectoryName(AppContext.BaseDirectory);//獲取應用程式所在目錄(絕對,不受工作目錄影響,建議採用此方法獲取路徑)
                var xmlPath = Path.Combine(basePath, "ERP.Api.xml");
                options.IncludeXmlComments(xmlPath);
            });
            #endregion 

全搞完之後,我們把預設路徑直接指向根路徑。
配置

測試

唉,沒有Values以後測試可怎麼過啊。

ok,我們來給預設創建的控制器寫個註釋。
測試

所有整理完畢之後,我們直接運行程式,這時就會發現,新版的swagger對於預設界面也是做了些調整的。
測試

小結

net core 3.0作為一個期待已久的版本,大統一的前景還是挺不錯的,編程語言只是一個工具,沒有好壞之分,所以無需糾結,你為何而編程,相信每個人心中都已有答案。


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

更多相關文章
  • 介面表示一種能力,實現了一個介面,即擁有一種能力。 BeanDefinition與Bean的關係, 就好比類與對象的關係. 類在spring的數據結構就是BeanDefinition.根據BeanDefinition得到的對象就是我們需要的Bean. 我認為理解Bean與BeanDefinition ...
  • @EnableAutoConfiguration註解是Spring Boot中配置自動裝載的總開關。本文將從@EnableAutoConfiguration入手,嘗試分析Spring Boot對@AutoConfigurationImportSelector註解的處理過程。 ...
  • 在GitHub上有個項目,本來是作為自己研究學習.net core的Demo,沒想到很多同學在看,還給了很多星,所以覺得應該升成3.0,整理一下,寫成博分享給學習.net core的同學們。 項目名稱:Asp.NetCoreExperiment 項目地址:https://github.c... ...
  • 本文轉自:https://www.cnblogs.com/shangwater/p/5449470.html 錯誤:程式集綁定日誌記錄被關閉。 解決方法: 將IIS中的應用程式服務池中"啟動32位應用程式"設置為true。 錯誤描述: 部署到IIS中的應用程式出現如下錯誤(Win7 x64位 .ne ...
  • 一、簡要說明 ABP vNext 當中的審計模塊早在 "依賴註入與攔截器" 一文中有所提及,但沒有詳細的對其進行分析。 審計模塊是 ABP vNext 框架的一個基本組件,它能夠提供一些實用日誌記錄。不過這裡的日誌不是說系統日誌,而是說介面每次調用之後的執行情況(執行時間、傳入參數、異常信息、請求 ...
  • 1.ServiceStack.Redis封裝 封裝的Redis操作類名為RedisHandle,如下代碼塊(只展示部分代碼),它的特點: 1)使用連接池管理連接,見代碼中的PooledClientManager屬性。如果不用連接池,而是代碼直接RedisClient client = new Red ...
  • public partial class App : System.Windows.Application { protected override void OnStartup(StartupEventArgs e) { base.OnStartup(e); SetupWindow... ...
  • 框架採用.NetCore + Vue前後端分離,並且支持前端、後臺代碼業務動態擴展,框架內置了一套有著20多種屬性配置的代碼生成器,可靈活配置生成的代碼,代碼生成器界面配置完成即可生成單表/主從表的增、刪、改、查、導入、導出、上傳、審核基礎功能。只需要簡單瞭解即可上手開發 框架基礎功能已構建完成,可 ...
一周排行
  • 微信公眾號: "Dotnet9" ,網站: "Dotnet9" ,問題或建議: "請網站留言" , 如果對您有所幫助: "歡迎贊賞" 。 .NET CORE(C ) WPF 值得推薦的動畫菜單設計 閱讀導航 1. 本文背景 2. 代碼實現 3. 本文參考 4. 源碼 1. 本文背景 YouTube上 ...
  • 1. HttpRequest對象 伺服器接收到http協議的請求後,會根據報文創建HttpRequest對象,這個對象不需要我們創建,直接使用伺服器構造好的對象就可以。視圖的第一個參數必須是HttpRequest對象,在django.http模塊中定義了HttpRequest對象的API。 1.1 ...
  • SpringMVC 攔截器 Spring MVC也可以使用攔截器對請求進行攔截處理,可以自定義攔截器來實現特定的功能,自定義的攔截器可以實現HandlerInterceptor介面中的三個方法,也可以繼承HandlerInterceptorAdapter 適配器類按照需要那個方法,就實現哪個方法 過 ...
  • 1. JDBC介紹 JDBC(Java DataBase Connectivity),即Java資料庫的連接。JDBC是一種用於執行SQL語句(DML,DDL,DQL)的Java API,可以為多種關係資料庫(oracle,mysql,sqlserver)提供統一訪問,它由一組用Java語言編寫的類 ...
  • [toc] 一、入門 1、Spring Boot簡介 簡化Spring應用開發的一個框架 整個Spring技術棧的整合 J2EE開發的一站式解決方案 2、微服務 Martin Fowler 微服務是一種架構風格 一個應用應該是一組小型服務:可以通過HTTP的方式進行互通 每一個功能元素最終都是一個可 ...
  • 首先如果直接使用 root 用戶來啟動 tomcat 的話,是可以正常啟動的。 但是我們在 Linux 中使用普通用戶啟動 tomcat 報瞭如下錯誤 原因是沒有在 setclasspath.sh 上設置 JAVA_HOME 和 JRE_HOME。 解決辦法: 打開 setclasspath.sh ...
  • 線上實時轉換 需要 .babelrc中: 項目中main.js配置: 前提是安裝對應的包 自己寫的要運行的為app.js,這樣配置後會在運行main.js是自動轉為es5並執行 通過配置手動轉換 需要 安裝babel後 運行 src為自己寫的es6目錄文件,dist為轉碼後的es5文件,沒有則創建 ...
  • 假如有兩個文件:app.js和config.js app.js為主文件要去引用config這個模塊 以前學習node時使用的模塊導出: es6中的模塊導出 方法一 兩種可以混合使用 方法二 通過 export 導出的成員必須通過解構賦值按需載入 或者通過 的形式載入所有通過 export 關鍵字導出 ...
  • 不做解釋,代碼一看就懂 app.js config.js ...
  • 對babel進行複習
x