玩轉C#之【Swagger 不是SWAG】
閱讀時間約 2 分鐘
大家要小心不要Google錯了
介紹
Swagger是SmartBear Software的API開發人員套件工具，它是OpenAPI規範的基礎規範。
簡單來說就是 API 文件產生器
在微軟的C#中有兩種Swagger的套件可以使用
- Swashbuckle
- NSwag
安裝方式
環境:ASP.NET6
NET6 目前如果用WebAPI專案範本會自動安裝好Swashbuckle
NET6 目前如果用WebAPI專案範本會自動安裝好Swashbuckle
Swashbuckle
Swashbuckle 有三個主要套件：
- Swashbuckle.AspNetCore.SwaggerGen：產生器是負責取得 API 的規格並產生
- Swashbuckle.AspNetCore.Swagger： 讀取SwaggerGen產生的規格讓URL可以查看
- Swashbuckle.AspNetCore.SwaggerUI：設定Swagger UI介面用
在Program.cs檔案中需要註冊AddSwaggerGen，並且在Middleware下加入
app.UseSwagger();
app.UseSwaggerUI();
NSwag
需要安裝的套件
NSwag.AspNetCore
NSwag.AspNetCore
在Program.cs檔案中需要註冊AddOpenApiDocument();，並且在Middleware下加入
app.UseOpenApi(); // serve OpenAPI/Swagger documents
app.UseSwaggerUi3(); // serve Swagger UI
app.UseReDoc(); // serve ReDoc UI
GitHub範例
關於設定註解、回傳格式、回傳型別、Authorize Token、設定API版本之後會專門寫一篇文章跟大家講解
關於設定註解、回傳格式、回傳型別、Authorize Token、設定API版本之後會專門寫一篇文章跟大家講解
參考資料
本篇已同步發表至個人部落格
https://moushih.com/2022ithome04/
https://moushih.com/2022ithome04/
鐵人賽文章:
為什麼會看到廣告
留言0
查看全部
你可能也想看
Google News 追蹤
這個秋，Chill 嗨嗨！穿搭美美去賞楓，裝備款款去露營⋯⋯你的秋天怎麼過？秋日 To Do List 等你分享！
秋季全站徵文，我們準備了五個創作主題，參賽還有機會獲得「火烤兩用鍋」，一起來看看如何參加吧～
美國總統大選只剩下三天， 我們觀察一整週民調與金融市場的變化（包含賭局）， 到本週五下午3:00前為止， 誰是美國總統幾乎大概可以猜到60-70%的機率， 本篇文章就是以大選結局為主軸來討論近期甚至到未來四年美股可能的改變
Faker昨天真的太扯了，中國主播王多多點評的話更是精妙，分享給各位
王多多的點評
「Faker是我們的處境，他是LPL永遠繞不開的一個人和話題，所以我們特別渴望在決賽跟他相遇，去直面我們的處境。
我們曾經稱他為最高的山，最長的河，以為山海就是盡頭，可是Faker用他28歲的年齡...
Token Extension的主角之一 Transfer Fee
目前官方釋出的代幣擴充功能總共 14 項，其中又以 Transfer fee 這個擴充為最多人使用。Transfer fee 嚴格規範了每筆轉帳交易的手續費，讓代幣的發行者擁有更好手續費來源，同時也保障 NFT 創作者的版稅收益。
今年一月正式推出的 Solana 上的新標準 Token Extension，重塑了之前 Solana 所使用的 token 協議，替 Solana的鏈上資產解放更多潛力。資產之間的交互將變得更靈活，除了讓帳戶之間的轉帳更有保障之外，也在 Defi 未來的結構性商品上產生了更多的想像空間。
《玩轉腦朋友2》刪除角色1：Shame 羞恥
在《玩轉腦朋友》的開發過程中，「羞恥」原本是27種情緒之一，最初設計為男性角色。但在續集中，「羞恥」被重新塑造成女性角色，預計成為新的情緒角色。然而，導演認為「羞恥」會讓萊莉的成長故事過於沉重和黑暗，因此將這種情緒融合進「阿焦」的性格中，成為「我不夠
通路創新和創意結合，帶來了許多令人驚喜的商業案例。從Amazon Go的無人商店到UBEREAT機器人送餐，不同品牌都在用新科技改變生活方式。本文分享了幾個成功的通路創新案例，絕對能啟發你的Idea！
進入物件導向設計的實戰階段，我們通過建立人力資源管理功能來實踐理論知識。透過這些實作練習，能夠深化對物件導向概念的理解，並學會如何在實際開發中應用這些概念。
在物件導向程式設計的進階階段，學生將學習繼承、介面、抽象類別等核心概念。繼承允許類別共享屬性和方法，介面確保實現類別提供特定的方法實現，而抽象類別定義了基本結構供子類別擴展。這些知識點有助於提升程式碼的重用性、擴展性和維護性。
暢銷懸疑小說的《法庭遊戲》改編為電影版，日前也在台灣上映，燒腦的情節加上法庭的諜對諜攻防；再加上永瀨廉、杉咲花、北村匠海三位高人氣演員加持。
自2020年問世以來，日本潮流品牌Water The Plant便以其獨特的設計理念和色彩豐富的產品系列，在全球潮流文化中掀起了一股正能量的旋風。
戴姆勒克萊斯勒出產的後輪驅動雙門跑車 Chrysler Crossfire（火線），使用 33% 賓士 SLK 跑車零件，在 2003 年推出，於 2007 年因為公司重組後停產。雖然，1:1 的新車買不起，那買台 1:18 的模型車來玩玩總是可以的。😜
這個秋，Chill 嗨嗨！穿搭美美去賞楓，裝備款款去露營⋯⋯你的秋天怎麼過？秋日 To Do List 等你分享！
秋季全站徵文，我們準備了五個創作主題，參賽還有機會獲得「火烤兩用鍋」，一起來看看如何參加吧～
美國總統大選只剩下三天， 我們觀察一整週民調與金融市場的變化（包含賭局）， 到本週五下午3:00前為止， 誰是美國總統幾乎大概可以猜到60-70%的機率， 本篇文章就是以大選結局為主軸來討論近期甚至到未來四年美股可能的改變
Faker昨天真的太扯了，中國主播王多多點評的話更是精妙，分享給各位
王多多的點評
「Faker是我們的處境，他是LPL永遠繞不開的一個人和話題，所以我們特別渴望在決賽跟他相遇，去直面我們的處境。
我們曾經稱他為最高的山，最長的河，以為山海就是盡頭，可是Faker用他28歲的年齡...
Token Extension的主角之一 Transfer Fee
目前官方釋出的代幣擴充功能總共 14 項，其中又以 Transfer fee 這個擴充為最多人使用。Transfer fee 嚴格規範了每筆轉帳交易的手續費，讓代幣的發行者擁有更好手續費來源，同時也保障 NFT 創作者的版稅收益。
今年一月正式推出的 Solana 上的新標準 Token Extension，重塑了之前 Solana 所使用的 token 協議，替 Solana的鏈上資產解放更多潛力。資產之間的交互將變得更靈活，除了讓帳戶之間的轉帳更有保障之外，也在 Defi 未來的結構性商品上產生了更多的想像空間。
《玩轉腦朋友2》刪除角色1：Shame 羞恥
在《玩轉腦朋友》的開發過程中，「羞恥」原本是27種情緒之一，最初設計為男性角色。但在續集中，「羞恥」被重新塑造成女性角色，預計成為新的情緒角色。然而，導演認為「羞恥」會讓萊莉的成長故事過於沉重和黑暗，因此將這種情緒融合進「阿焦」的性格中，成為「我不夠
通路創新和創意結合，帶來了許多令人驚喜的商業案例。從Amazon Go的無人商店到UBEREAT機器人送餐，不同品牌都在用新科技改變生活方式。本文分享了幾個成功的通路創新案例，絕對能啟發你的Idea！
進入物件導向設計的實戰階段，我們通過建立人力資源管理功能來實踐理論知識。透過這些實作練習，能夠深化對物件導向概念的理解，並學會如何在實際開發中應用這些概念。
在物件導向程式設計的進階階段，學生將學習繼承、介面、抽象類別等核心概念。繼承允許類別共享屬性和方法，介面確保實現類別提供特定的方法實現，而抽象類別定義了基本結構供子類別擴展。這些知識點有助於提升程式碼的重用性、擴展性和維護性。
暢銷懸疑小說的《法庭遊戲》改編為電影版，日前也在台灣上映，燒腦的情節加上法庭的諜對諜攻防；再加上永瀨廉、杉咲花、北村匠海三位高人氣演員加持。
自2020年問世以來，日本潮流品牌Water The Plant便以其獨特的設計理念和色彩豐富的產品系列，在全球潮流文化中掀起了一股正能量的旋風。
戴姆勒克萊斯勒出產的後輪驅動雙門跑車 Chrysler Crossfire（火線），使用 33% 賓士 SLK 跑車零件，在 2003 年推出，於 2007 年因為公司重組後停產。雖然，1:1 的新車買不起，那買台 1:18 的模型車來玩玩總是可以的。😜