向net core 3.0進(jìn)擊——Swagger的改變

前言

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

引入

按之前的習(xí)慣,對(duì)于引入我是不會(huì)多說(shuō),一個(gè)鏈接(我自己之前引入那些截圖)就給大家了,但是因?yàn)?.0屬于比較新的版本,所以在引入的時(shí)候,有些注意點(diǎn)還是要標(biāo)注下的。


引入

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

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


引入
            #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1.1.0",
                    Title = "ERP WebAPI",
                    Description = "后臺(tái)框架",
                    Contact = new OpenApiContact() { Name = "Blank", Email = "1829027193@qq.com", Url = new Uri("https://www.cnblogs.com/AprilBlank/") }
                });
            });
            #endregion 

在使用注冊(cè)引用的地方倒是沒(méi)有變化。


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

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


生成

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


生成
            #region Swagger
            services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new OpenApiInfo
                {
                    Version = "v1.1.0",
                    Title = "ERP WebAPI",
                    Description = "后臺(tái)框架",
                    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)用程序所在目錄(絕對(duì),不受工作目錄影響,建議采用此方法獲取路徑)
                var xmlPath = Path.Combine(basePath, "ERP.Api.xml");
                options.IncludeXmlComments(xmlPath);
            });
            #endregion 

全搞完之后,我們把默認(rèn)路徑直接指向根路徑。


配置

測(cè)試

唉,沒(méi)有Values以后測(cè)試可怎么過(guò)啊。

ok,我們來(lái)給默認(rèn)創(chuàng)建的控制器寫(xiě)個(gè)注釋。


測(cè)試

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


測(cè)試

小結(jié)

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

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

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

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

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