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

前言

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

引入

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


引入

在3.0中,我們會在Startup這里發(fā)現(xiàn),Mvc沒了統(tǒng)一替換成Controllers,當然這并不影響我們使用,但是最關(guān)鍵的,我們用來實驗的Values木得了,取而代之的是一個挺不錯的api的WeatherForecast接口

引入之后,我們還復(fù)制我們之前的swagger配置內(nèi)容來試試,會發(fā)現(xiàn)新版也針對類名,屬性做了雪微的調(diào)整,這里直接一張圖就可以看到。


引入
            #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");
                //如果設(shè)置根目錄為swagger,將此值置空
                options.RoutePrefix = string.Empty;
            });
            #endregion

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


生成

然后,我們直接復(fù)制之前的配置內(nèi)容即可。


生成
            #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設(shè)置xml文檔注釋路徑
                var basePath = Path.GetDirectoryName(AppContext.BaseDirectory);//獲取應(yīng)用程序所在目錄(絕對,不受工作目錄影響,建議采用此方法獲取路徑)
                var xmlPath = Path.Combine(basePath, "ERP.Api.xml");
                options.IncludeXmlComments(xmlPath);
            });
            #endregion 

全搞完之后,我們把默認路徑直接指向根路徑。


配置

測試

唉,沒有Values以后測試可怎么過啊。

ok,我們來給默認創(chuàng)建的控制器寫個注釋。


測試

所有整理完畢之后,我們直接運行程序,這時就會發(fā)現(xiàn),新版的swagger對于默認界面也是做了些調(diào)整的。


測試

小結(jié)

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

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

  • 日更已經(jīng)堅持到第22天了。在這22天里,每天我都會給自己留出一點時間,讓自己靜靜的寫點東西。在每次寫的過程中其實是...
    戀上清咖閱讀 253評論 2 4
  • 參加鉆石行動后,按照魔法廣場模板制定了2016年下半年的核心計劃,并以《目標設(shè)定三步曲》為題輸出了自己的感受 (h...
    快魚up閱讀 458評論 0 0
  • (杏花天) 史上孟德懟仲謀, 嘆周郎, 下啥賭注。 火燒赤壁借東風, 亮明三觀撗豎! 競自由, 牛渡鵲橋。 強說愛...
    9fcceae7d4b8閱讀 135評論 0 0
  • 感恩日記 深深地感恩自己,我的胳膊勞累了幾天了,今天最累,您辛苦了我深深地感恩您,為了讓家顯得干凈些,您為我做了好...
    張蓉萍閱讀 128評論 0 0
  • 好久沒生病了,回趟老家,過來就渾身難受,沒勁,流鼻涕,嗓子痛。 難道是因為回家,站票累的? 家里真的好冷,早上起來...
    日知智閱讀 226評論 0 0

友情鏈接更多精彩內(nèi)容