Swagger 用來產生文件和即時測試網站,是開發人員的小幫手,再搭配 PostMan 來產生 C# (RestClient),可以提升整體的開發速度
開發環境
- VS 2017 15.8.4
- Swashbuckle 5.6.0
步驟
新增一個 Web API 專案
安裝套件
如果是 IIS 環境,安裝 Install-Package Swashbuckle
如果是 Self-Hosted (OWIN)環境,安裝 Install-Package Swashbuckle.Core
完成之後連接 /swagger,如下畫面
這樣就完成了,便可使用它來測試 Web API 了。
文件說明還不夠,接下來,輸出 XML 位置
在 SwaggerConfig.cs 反註解 c.IncludeXmlComments(GetXmlCommentsPath());
在程式內讀取路徑
private static string GetXmlCommentsPath()
{
return Path.Combine(System.AppDomain.CurrentDomain.BaseDirectory, @"App_Data\WebApplication1.XML");
}
註解是用三個反斜線寫的
若有謬誤,煩請告知,新手發帖請多包涵
Microsoft MVP Award 2010~2017 C# 第四季
Microsoft MVP Award 2018~2022 .NET