【轉】C# 在webapi項目中配置Swagger
阿新 • • 發佈:2017-12-03
rect static void target 來源 public 圖片 網址 class
以前在做WebAPI調用測試時,一直在使用Fiddler測試工具了,而且這個用起來比較繁瑣,需要各種配置,並且不直觀,還有一點是還得弄明白URL地址和要傳遞的參數,然後才能調用。 最近新入職,公司裏面也用到了WebAPI調用,但是使用的調用工具讓我眼前一亮,他用的是Swagger。這個工具可能有的人沒聽說過,它僅僅引用一個包即可嵌入到項目中,用的時候直接輸入網址就能看到調用界面了。你是不是之前也沒用過呢,是的話,那請看下面介紹吧~
1. 首先,創建webpapi類型的項目 TestSwagger
2.使用 Nuget 安裝Swashbuckle.core包
安裝完成後,即可看到這些類與文件都是安裝完成時swagger添加的。
3. 打開xml文檔文件
右鍵項目屬性—>生成—>勾選XML文檔文件
4.添加註釋
我們發現,安裝完成後,寫註釋並沒有在swagger頁面上面增加,所以我們現在開啟註釋
在SwaggerConfig類中,EnableSwagger的時候添加下面XML解析
using System.Web.Http; using WebActivatorEx; using TestSwagger; using Swashbuckle.Application; [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")] namespace TestSwagger { public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuration .EnableSwagger(c => { c.SingleApiVersion("v1", "TestSwagger"); //添加XML解析 c.IncludeXmlComments(GetXmlCommentsPath()); }) .EnableSwaggerUi(c => { }); } //添加XML解析 private static string GetXmlCommentsPath() { return string.Format("{0}/bin/TestSwagger.XML", System.AppDomain.CurrentDomain.BaseDirectory); } } }
註意修改相應的XML名字。
來源:https://www.cnblogs.com/alunchen/p/6888002.html
【轉】C# 在webapi項目中配置Swagger