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

[toc]html

前言

十一小長假在不知不覺間可都沒了，在這個小尾巴的空隙，把這兩天鼓搗的net core 3.0升級過程記錄一下，首先仍是根據以前的順序一個個補充進來，先從Swagger的變化提及（新建工程什麼的很少說了，就是選擇的時候選3.0就能夠了，2019新版更新後建立默認都是3.0）。編程

引入

按以前的習慣，對於引入我是不會多說，一個連接（我本身以前引入那些截圖）就給你們了，可是由於3.0屬於比較新的版本，因此在引入的時候，有些注意點仍是要標註下的。 json

在3.0中，咱們會在Startup這裏發現，Mvc沒了統一替換成Controllers，固然這並不影響咱們使用，可是最關鍵的，咱們用來實驗的Values木得了，取而代之的是一個挺不錯的api的WeatherForecast接口api

引入以後，咱們還複製咱們以前的swagger配置內容來試試，會發現新版也針對類名，屬性作了雪微的調整，這裏直接一張圖就能夠看到。 app

#region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1.1.0",
                    Title = "ERP WebAPI",
                    Description = "後臺框架",
                    Contact = new OpenApiContact() { Name = "Blank", Email = "1829027193@qq.com", 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 = "1829027193@qq.com", 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之後測試可怎麼過啊。spa

ok，咱們來給默認建立的控制器寫個註釋。

全部整理完畢以後，咱們直接運行程序，這時就會發現，新版的swagger對於默認界面也是作了些調整的。

小結

net core 3.0做爲一個期待已久的版本，大統一的前景仍是挺不錯的，編程語言只是一個工具，沒有好壞之分，因此無需糾結，你爲什麼而編程，相信每一個人心中都已有答案。

原文出處：https://www.cnblogs.com/AprilBlank/p/11633522.html