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


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

更多相關文章
  • 類型和變數 [C#類型和變數(原文參考官方教程)]https://docs.microsoft.com/zh-cn/dotnet/csharp/tour-of-csharp/types-and-variables C#有兩種類型: 1. 值類型 1. 簡單類型 2. 枚舉類型 格式為 enum E ...
  • 委托 1. C# 中的委托類似於 C 或 C++ 中指向函數的指針。委托表示引用某個方法的引用類型變數,運行時可以更改引用對象。 2. 特別地,委托可以用於處理事件或回調函數。並且,所有的委托類都是從 System.Delegate 類繼承而來。 聲明委托的語法規則:(被委托所引用的方法需有相同的參 ...
  • C#程式計算N階行列式的值及N元一次方程組 用了挺長時間自行完成了C#程式計算N階行列式的值及N元一次方程組。由於自己沒有在網上查閱其他資料,所以只能硬著頭皮用最朴素的思想和基礎的演算法進行編程。在給出代碼之前,我先簡單發表一些自己的粗鄙之見。。。 1.數學思想:有了線性代數中高斯提供的公式,我們很容 ...
  • 點這裡進入ABP進階教程目錄 添加實體 打開領域層(即JD.CRS.Core)的Entitys目錄 //用以存放實體對象添加一個類StatusCode.cs //狀態信息 1 using System; 2 using System.Collections.Generic; 3 using Syst ...
  • 場景 WInforn中設置ZedGraph的焦點顯示坐標格式化以及顯示三個坐標數的解決辦法: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/102466190 Winform中實現ZedGraph的多條Y軸(附源碼下載): htt ...
一周排行
  • 一、背景 代碼實例:https://gitee.com/D_C_L/CurtainEtcAOP.git我們實際系統中有很多操作,是不管做多少次,都應該產生一樣的效果或返回一樣的結果。 例如: 1. 前端重覆提交選中的數據,應該後臺只產生對應這個數據的一個反應結果。 2. 我們發起一筆付款請求,應該只 ...
  • 關鍵字:流程未來節點處理人 工作流快速開發平臺 工作流流設計 業務流程管理 asp.net 開源工作流 業務背景:一個流程在啟動起來後,是可以對一些節點計算出來處理人是誰,流程的走向。對於另外一些節點處理人有可能需要相關的人員調整的。在一些審批的環境下,需要把能夠計算出來的節點處理人在發起時計算出來... ...
  • 簡述 我們做軟體工作的雖然每天都離不開網路,可網路協議細節卻不是每個人都會接觸和深入瞭解。我今天就來和大家一起學習下Socket,並寫一個簡單的聊天程式。 一些基礎類 首先我們每天打開瀏覽器訪問網頁信息都是使用的HTTP/HTTPS協議,而HTTP是通過的TCP建立的連接。TCP底層又是通過的Soc ...
  • 點這裡進入ABP進階教程目錄 在功能按鈕區增加一個自定義按鈕 - Add(創建課程) 添加按鈕 打開展示層(即JD.CRS.Web.Mvc)的\wwwroot\view-resources\Views\Course\Index.js //用以存放Course查詢相關腳本 自帶按鈕已有五個我們再添加一 ...
  • 點這裡進入ABP進階教程目錄 我們嘗試在新增/編輯界面增加一個下拉框用來代替輸入框編輯Status 添加實體 打開領域層(即JD.CRS.Core)的Entitys目錄 //用以存放實體對象添加一個類StatusCode.cs //狀態信息 更新模型 更新查詢視圖模型 打開展示層(即JD.CRS.W ...
  • 在項目視圖中,找到-》輸出 視窗,在視窗中選擇ASP.NET Core Web伺服器,調試項目即可看到執行的sql語句 ...
  • 前言: 通過Fiddler抓取瀏覽器請求數據,相信大家已經都會用了,我們知道Fiddler是通過在本機計算器添加一個預設的代理伺服器來實現的抓包數據的,埠號為:8888。 其實當我們打開Fiddler的設置也可以看到: 然後查看本地計算器的網路代理設置: 基於上面的原理,Fiddler就實現了經過 ...
  • 場景 Winform控制項-DevExpress18下載安裝註冊以及在VS中使用: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100061243 在上面已經實現DevExpress的安裝之後,拖拽一個TreeList,然後怎樣給 ...
  • 場景 Winform控制項-DevExpress18下載安裝註冊以及在VS中使用: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/100061243 DevExpress的TreeList怎樣設置數據源,從實例入手: https:/ ...
  • 場景 在開發中,經常會有一些全局作用域的常量、欄位、屬性、方法等。 需要將這些設置為全局作用域保存且其實例唯一。 註: 博客主頁: https://blog.csdn.net/badao_liumang_qizhi 關註公眾號 霸道的程式猿 獲取編程相關電子書、教程推送與免費下載。 實現 首先新建一 ...
x