玩轉C#之【Swagger 不是SWAG】
大家要小心不要Google錯了
介紹
Swagger是SmartBear Software的API開發人員套件工具，它是OpenAPI規範的基礎規範。
簡單來說就是 API 文件產生器
在微軟的C#中有兩種Swagger的套件可以使用
- Swashbuckle
- NSwag
安裝方式
環境:ASP.NET6
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
在Program.cs檔案中需要註冊AddOpenApiDocument();，並且在Middleware下加入
app.UseOpenApi(); // serve OpenAPI/Swagger documents
app.UseSwaggerUi3(); // serve Swagger UI
app.UseReDoc(); // serve ReDoc UI
GitHub範例
關於設定註解、回傳格式、回傳型別、Authorize Token、設定API版本之後會專門寫一篇文章跟大家講解
參考資料
本篇已同步發表至個人部落格
https://moushih.com/2022ithome04/
鐵人賽文章:
app.UseSwagger();
app.UseSwaggerUI(); 需要安裝的套件
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版本之後會專門寫一篇文章跟大家講解
參考資料
本篇已同步發表至個人部落格
https://moushih.com/2022ithome04/
鐵人賽文章:
分享至
成為作者繼續創作的動力吧！
作者的相關文章
一代軍師 的其他內容
你可能也想看
- 「天天秋嗨嗨」：vocus 秋季徵文，五大主題 & 獎品登場！
- 美國大選『終局之戰』（Endgame）即將展開， 美股將迎來新世紀？（上篇：模型推導寶座花落誰家？）
- 如果這個世界有神，那祂一定姓李名相赫｜矮袋鼠律師
- 玩轉 Solana 上的 Defi 模組 - Token Extension（下）
- 玩轉 Solana 上的 Defi 模組 - Token Extension（上）
- 《玩轉腦朋友2-Inside out 2》8大落選角色大公開(轉發)
- 玩轉名古屋NaGoya-行程分享
- 玩轉通路微創新！這些品牌的革命性商業模式值得參考
- 跟PHP一起玩轉物件導向：從玩具箱到工具箱-實戰應用
- 跟PHP一起玩轉物件導向：從玩具箱到工具箱-進階概念
- 日影／玩轉法律的《法庭遊戲》，充滿反轉、諜對諜鬥志戲碼！
- 玩轉閃電倒勾！解密日本品牌WATER THE PLANT潮鞋秘辛！
- 玩轉模型車．享生活
發表回應
成為會員 後即可發表留言
© 2024 vocus All rights reserved.