玩轉C#之【Swagger 不是SWAG】
大家要小心不要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 追蹤
徵的就是你 🫵 超ㄅㄧㄤˋ 獎品搭配超瞎趴的四大主題，等你踹共啦！還有機會獲得經典的「偉士牌樂高」喔！馬上來參加本次的活動吧！
隨著理財資訊的普及，越來越多台灣人不再將資產侷限於台股，而是將視野拓展到國際市場。特別是美國市場，其豐富的理財選擇，讓不少人開始思考將資金配置於海外市場的可能性。
然而，要參與美國市場並不只是盲目跟隨標的這麼簡單，而是需要策略和方式，尤其對新手而言，除了選股以外還會遇到語言、開戶流程、Ap
ASP.NET 9.0 WebAPI - 消失的swagger ,改用OpenAPI 與 Scalar ,測試WebAPI的好工具
.NET 9.0預設採用 OpenAPI，可以搭配Scalar取代以前的swagger，幫我們簡易測試WebAPI的功能
※ 什麼是Web API
API 就是後端開出來讓前端來用的介面，讓前端與後端可以溝通。
API流程：
終端使用者用任何一種裝置進入瀏覽器。
瀏覽器透過 API 向後端發出請求，請求查詢或修改資料。
後端透過 API 收到前端的請求後，取得資料並回應給前端。
前端渲染畫面，終端使用者
※ 原本狀態：伺服器渲染
這是 MVC 架構下的 request / response 示意圖，在這張圖呈現的架構裡，畫面和資料都由同一個架構處理。
伺服器渲染流程：
瀏覽器針對特定網址送出請求。
路由器解析請求後，轉接給對應的 controller。
controller 按照要求，透過
本文檔介紹了在Swift中使用套件的詳細方法，包括如何引用第三方套件和自定義模組，如何創建自定義套件，以及一些常見的Swift套件。這些套件可以幫助開發者快速添加功能到項目中，提高開發效率和程式碼品質。
本章講述了C#開發中的程序集，命名空間和 NuGet 包管理器。程序集是 .NET 應用的基礎，命名空間用於組織和預防命名衝突，而 NuGet 用於管理 .NET 的外部庫和依賴項。
除了上篇提到的 Data Wrangler 外，SageMaker 還有許多配套的功能，其中有個叫做 Pipelines 的東西，說是可以用來構建、 管理及自動化深度學習流程，能夠節省人工操作，有那麼神?這次就來試試 Pipelines 能夠為我們帶來什麼體驗。
在上篇我們已經學習到怎麼在 SageMaker 上進行簡易訓練，可以說是踏入了第一步， SageMaker 提供了不少工具用來協助使用者能夠更快速的進行訓練，其中 Data Wrangler 便是用於訓練資料處理的工具，那麼，他好用嗎?必須用嗎?
SpiffWorkflow 是一個專門針對業務流程的流程引擎，它與商業 BPMN 產品有所區別，適合應用在自有專案中，並且需要內含稍微複雜的商業流程。例如，對於需要外部程式與前端配合才能真正讓用戶輸入決斷的場景，SpiffWorkflow 是一個適合的解決方案。
※ 什麼是 RESTful API？
這種運用 HTTP 來表達語義的路由設計風格稱為 RESTful API，它描述了如何實現 Web API 的架構。所謂的 API 是應用程式介面 (application programming interface)，網址也是一種應用程式的「介面」，故稱為
使用Python開發後端API的經驗中應該會常常看到WSGI與ASGI這兩個名詞， 兩者的差異究竟是什麼呢？ 就讓我們來為您科普一番。
什麼是WSGI
全名為「Web Server Gateway Interface」 Web伺服器閘道介面，主要規範HTTP請求如何與伺服器溝通， 通
徵的就是你 🫵 超ㄅㄧㄤˋ 獎品搭配超瞎趴的四大主題，等你踹共啦！還有機會獲得經典的「偉士牌樂高」喔！馬上來參加本次的活動吧！
隨著理財資訊的普及，越來越多台灣人不再將資產侷限於台股，而是將視野拓展到國際市場。特別是美國市場，其豐富的理財選擇，讓不少人開始思考將資金配置於海外市場的可能性。
然而，要參與美國市場並不只是盲目跟隨標的這麼簡單，而是需要策略和方式，尤其對新手而言，除了選股以外還會遇到語言、開戶流程、Ap
ASP.NET 9.0 WebAPI - 消失的swagger ,改用OpenAPI 與 Scalar ,測試WebAPI的好工具
.NET 9.0預設採用 OpenAPI，可以搭配Scalar取代以前的swagger，幫我們簡易測試WebAPI的功能
※ 什麼是Web API
API 就是後端開出來讓前端來用的介面，讓前端與後端可以溝通。
API流程：
終端使用者用任何一種裝置進入瀏覽器。
瀏覽器透過 API 向後端發出請求，請求查詢或修改資料。
後端透過 API 收到前端的請求後，取得資料並回應給前端。
前端渲染畫面，終端使用者
※ 原本狀態：伺服器渲染
這是 MVC 架構下的 request / response 示意圖，在這張圖呈現的架構裡，畫面和資料都由同一個架構處理。
伺服器渲染流程：
瀏覽器針對特定網址送出請求。
路由器解析請求後，轉接給對應的 controller。
controller 按照要求，透過
本文檔介紹了在Swift中使用套件的詳細方法，包括如何引用第三方套件和自定義模組，如何創建自定義套件，以及一些常見的Swift套件。這些套件可以幫助開發者快速添加功能到項目中，提高開發效率和程式碼品質。
本章講述了C#開發中的程序集，命名空間和 NuGet 包管理器。程序集是 .NET 應用的基礎，命名空間用於組織和預防命名衝突，而 NuGet 用於管理 .NET 的外部庫和依賴項。
除了上篇提到的 Data Wrangler 外，SageMaker 還有許多配套的功能，其中有個叫做 Pipelines 的東西，說是可以用來構建、 管理及自動化深度學習流程，能夠節省人工操作，有那麼神?這次就來試試 Pipelines 能夠為我們帶來什麼體驗。
在上篇我們已經學習到怎麼在 SageMaker 上進行簡易訓練，可以說是踏入了第一步， SageMaker 提供了不少工具用來協助使用者能夠更快速的進行訓練，其中 Data Wrangler 便是用於訓練資料處理的工具，那麼，他好用嗎?必須用嗎?
SpiffWorkflow 是一個專門針對業務流程的流程引擎，它與商業 BPMN 產品有所區別，適合應用在自有專案中，並且需要內含稍微複雜的商業流程。例如，對於需要外部程式與前端配合才能真正讓用戶輸入決斷的場景，SpiffWorkflow 是一個適合的解決方案。
※ 什麼是 RESTful API？
這種運用 HTTP 來表達語義的路由設計風格稱為 RESTful API，它描述了如何實現 Web API 的架構。所謂的 API 是應用程式介面 (application programming interface)，網址也是一種應用程式的「介面」，故稱為
使用Python開發後端API的經驗中應該會常常看到WSGI與ASGI這兩個名詞， 兩者的差異究竟是什麼呢？ 就讓我們來為您科普一番。
什麼是WSGI
全名為「Web Server Gateway Interface」 Web伺服器閘道介面，主要規範HTTP請求如何與伺服器溝通， 通