ASP.NET Web API #Swagger

ASP.NET Web API #Swagger

前言

ASP.NET Web API 有預設的 Help Page，可以幫助產生 API 文件，供開發人員檢視，但無法直接進行互動(可以額外安裝其他套件)。

本篇將介紹另外一套 Swagger 套件，不但可以產生美觀的 API 文件，還可以直接在上面進行測試。

Sample Web API Project

本篇將不會重頭開始建立 WebAPI Project，但會將 Sample Code 透過 Github 分享，可以至下方連結下載使用。

SwaggerSample

Install

Swashbuckle NuGet Package

Step 1. 在 WebAPI 專案開啟 NuGet Package Manager

Step 2. 搜尋 Swashbuckle 後進行安裝

Open Swagger Page

Step 1. 專案執行後預設畫面

Step 2. Swagger Page

Step 3. Swagger Page(展開)

Try it out!

Step 1. 找到要測試的 API

Step 2. 點選 Try it out!

為 API 加上註解說明

Step 1. 在 Controller 及 Action 增加 Summary 註解

Step 2. 輸出 XML 文件檔案

Step 3. 設定 SwaggerConfig.cs

Step 4. 找到 IncludeXmlComments 並取消註解

Step 5. 實作 GetXmlCommentsPath()

重新編譯後並執行，可以看到頁面已經會顯示 API 的相關說明囉

參考資料

文章內容的敘述如有錯誤及觀念不正確，請不吝嗇指教，如有侵權內容也請您與我反應。感謝您~

Swagger
Swashbuckle