Asp.net WebApi 生成SwaggerUI文檔
阿新 • • 發佈：2017-07-27
包含 新建 eba 屬性 strong 解析 cnblogs pre har
我們為什麽需要文檔
好的文檔能夠讓前後端開發溝通更輕松
Swagger ui 文檔的優點
可在線測試的，方便前後端調試
使用步驟
- 新建WebApi 項目
- Nuget 引入相應的類庫 Install-Package Swashbuckle （swaggerui 2.0）
- 引入之後，會在App_Start 目錄生成 SwaggerConfig.cs 文件
- 修改 SwaggerConfig.cs 文件 c.IncludeXmlComments 函數，引入需要包含的 xml 文件（c# summary 註釋會自動生成xml文件）
- 多個項目需要引入多個xml文件
- 修改每個項目對應的屬性-》build-》輸出-》勾選 xml文檔文件
- 啟動項目 訪問 xxx:xx/swagger 就能看到自動生成文檔了，對應json，可以查看swaggerui 頭部輸入框裏的 連接
常見錯誤
1 直接訪問加載不出來文檔，如果使用json.net的序列化，需要設置 NullHanding 為 ignore
settings.NullValueHandling = NullValueHandling.Ignore;
2 如果生成的復雜參數沒有正確解析為對象，請檢查是否設置了 json.net 駝峰 返回
Asp.net WebApi 生成SwaggerUI文檔