玩轉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
查看全部
一代軍師 的其他內容
你可能也想看
創作者要怎麼好好休息 + 避免工作過量？《黑貓創作報#4》午安，最近累不累？
這篇不是虛假的關心。而是《黑貓創作報》發行以來可能最重要的一篇。
是的，我們這篇講怎麼補充能量，也就是怎麼休息。
2024-06-29
跟PHP一起玩轉物件導向：從玩具箱到工具箱-實戰應用進入物件導向設計的實戰階段，我們通過建立人力資源管理功能來實踐理論知識。透過這些實作練習，能夠深化對物件導向概念的理解，並學會如何在實際開發中應用這些概念。
2024-04-13
跟PHP一起玩轉物件導向：從玩具箱到工具箱-進階概念在物件導向程式設計的進階階段，學生將學習繼承、介面、抽象類別等核心概念。繼承允許類別共享屬性和方法，介面確保實現類別提供特定的方法實現，而抽象類別定義了基本結構供子類別擴展。這些知識點有助於提升程式碼的重用性、擴展性和維護性。
2024-04-13
日影／玩轉法律的《法庭遊戲》，充滿反轉、諜對諜鬥志戲碼！暢銷懸疑小說的《法庭遊戲》改編為電影版，日前也在台灣上映，燒腦的情節加上法庭的諜對諜攻防；再加上永瀨廉、杉咲花、北村匠海三位高人氣演員加持。
2024-03-27
玩轉閃電倒勾！解密日本品牌WATER THE PLANT潮鞋秘辛！自2020年問世以來，日本潮流品牌Water The Plant便以其獨特的設計理念和色彩豐富的產品系列，在全球潮流文化中掀起了一股正能量的旋風。
2024-02-24
玩轉模型車．享生活戴姆勒克萊斯勒出產的後輪驅動雙門跑車 Chrysler Crossfire（火線），使用 33% 賓士 SLK 跑車零件，在 2003 年推出，於 2007 年因為公司重組後停產。雖然，1:1 的新車買不起，那買台 1:18 的模型車來玩玩總是可以的。😜
2024-02-05
玩轉你的影像 --- 美圖秀秀APP 「AI 繪畫藝術」多種畫風一鍵生成 3-2透過美圖秀秀APP「AI 繪畫藝術」測試版，你會發現龍虎塔的塔，你會發現龍虎塔的塔型，變得更古色古香，有些還幻化成了日本建築風格，塔前的石橋被東方風格的街頭古燈所取代，潭前的荷花池全轉換成荷花池全轉換成了日式的庭園與石階，與西式的建築與路燈，上面還被白雪覆蓋著，連塔邊的樹種，天際的背景也有了轉換，東
2022-12-19
玩轉你的影像 --- 美圖秀秀APP 「AI 繪畫藝術」多種畫風一鍵生成 3-1每年各種APP都會推出各種免費的年節電子賀卡，有的免費有的要付費，耶誕節、台灣元旦新年、農曆過年與西洋情人節陸續將至，如果你有寄發電子賀卡的習慣，今年不妨試試以下推薦的新玩意--- 免費的「美圖秀秀APP 「AI 繪畫藝術」多種畫風一鍵生成」!
2022-12-19
玩轉餐桌在餐桌上，時不時喜歡做些新鮮的嘗試，不管是食材的搭配或是烹調的方法，又或是餐桌（就是道具很多啦）的形式，菜色的嘗試往往都來自於看到臉友PO的美食照，或者是自己在外面用餐時看到的擺盤與菜餚，本以為這些嘗試的最大樂趣是複製成功，但後來發現真正有趣的是過程中的摸索。
2022-09-18
玩轉幾何框架：希臘 C_29 / ’Optimist’ 眼鏡店C_29 / 'Optimist' 的整體空間是由雅典知名的 314 architecture studio 所打造，創立者 Pavlo Hatjiaggelide 的背景是一名專業的土木工程師，擅長架構設計和室內設計，其設計作品就像是高純度的藝術品。
2022-05-16
NEXO收息平台開戶優惠，領取$25 in Bitcoin︱小K教你如何玩轉NEXO加密貨幣收息平台︱小K投資之路相比起Celsius每週派息一次，NEXO的好處就是它會每天派息一次，只要在每天07:00-08:00 CET時區前存入資金便可以開始計算利息，如果過了這個時段才存入資金的話，便可能要等24小時以上才能獲得利息了XD。
b. 填寫你的 Email 和密碼
【個人網站】
【加密貨幣】
【被動收入】
2021-12-25