.net core添加swagger文檔支持

1、首先引用nuget包:Swashbuckle.AspNetCore

我使用的是.net core 3.0的,需要引用的的nuget包是5.0預(yù)覽版的

添加中間件

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo
    {
        Title = "Curry API",
        Description = "API for Curry",
        Version = "v1",
        Contact = new OpenApiContact() { Name = "Curry", Email = "85232564@qq.com" }
    });
    
    var xmlPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Api.xml");
    c.IncludeXmlComments(xmlPath);
});

使用

app.UseSwagger();

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Curry V1");
});

為輸出xml配置路徑,以保證和我們使用的路徑一致倦零,這樣才能顯示出接口中的注釋文字


當(dāng)然我們在正式環(huán)境接口信息不宜暴露,可以通過環(huán)境變量來控制

隨便寫兩個接口測試下,運(yùn)行


最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末形导,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子习霹,更是在濱河造成了極大的恐慌朵耕,老刑警劉巖,帶你破解...
    沈念sama閱讀 212,029評論 6 492
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件淋叶,死亡現(xiàn)場離奇詭異阎曹,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 90,395評論 3 385
  • 文/潘曉璐 我一進(jìn)店門处嫌,熙熙樓的掌柜王于貴愁眉苦臉地迎上來栅贴,“玉大人,你說我怎么就攤上這事熏迹¢苁恚” “怎么了?”我有些...
    開封第一講書人閱讀 157,570評論 0 348
  • 文/不壞的土叔 我叫張陵注暗,是天一觀的道長坛缕。 經(jīng)常有香客問我,道長捆昏,這世上最難降的妖魔是什么赚楚? 我笑而不...
    開封第一講書人閱讀 56,535評論 1 284
  • 正文 為了忘掉前任,我火速辦了婚禮骗卜,結(jié)果婚禮上宠页,老公的妹妹穿的比我還像新娘。我一直安慰自己膨俐,他們只是感情好勇皇,可當(dāng)我...
    茶點故事閱讀 65,650評論 6 386
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著焚刺,像睡著了一般敛摘。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上乳愉,一...
    開封第一講書人閱讀 49,850評論 1 290
  • 那天跑慕,我揣著相機(jī)與錄音甲捏,去河邊找鬼。 笑死,一個胖子當(dāng)著我的面吹牛付魔,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播司澎,決...
    沈念sama閱讀 39,006評論 3 408
  • 文/蒼蘭香墨 我猛地睜開眼物独,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了备闲?” 一聲冷哼從身側(cè)響起晌端,我...
    開封第一講書人閱讀 37,747評論 0 268
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎恬砂,沒想到半個月后咧纠,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 44,207評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡泻骤,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,536評論 2 327
  • 正文 我和宋清朗相戀三年漆羔,在試婚紗的時候發(fā)現(xiàn)自己被綠了梧奢。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,683評論 1 341
  • 序言:一個原本活蹦亂跳的男人離奇死亡演痒,死狀恐怖亲轨,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情嫡霞,我是刑警寧澤瓶埋,帶...
    沈念sama閱讀 34,342評論 4 330
  • 正文 年R本政府宣布,位于F島的核電站诊沪,受9級特大地震影響养筒,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜端姚,卻給世界環(huán)境...
    茶點故事閱讀 39,964評論 3 315
  • 文/蒙蒙 一晕粪、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧渐裸,春花似錦巫湘、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,772評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至洞渤,卻和暖如春阅嘶,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背载迄。 一陣腳步聲響...
    開封第一講書人閱讀 32,004評論 1 266
  • 我被黑心中介騙來泰國打工讯柔, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人护昧。 一個月前我還...
    沈念sama閱讀 46,401評論 2 360
  • 正文 我出身青樓魂迄,卻偏偏與公主長得像,于是被迫代替她去往敵國和親惋耙。 傳聞我的和親對象是個殘疾皇子捣炬,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 43,566評論 2 349