溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
小編給大家分享一下c# webapi如何配置swagger，希望大家閱讀完這篇文章后大所收獲，下面讓我們一起去探討吧！
如何配置swagger
在使用項目中，我們希望去查看我們的webapi的測試，那么我們是需要去有一個集成的測試的。
步驟
1.在nutget管理包中下載swagger包。
2.這樣會在App_start 文件夾中出現swaggerconfig.cs 和swaggerNet.cs,
這個時候就需要配置的時候了。
3.取消下面的注釋(swaggerconfig.cs)
c.IncludeXmlComments(string.Format("{0}/bin/ThinkingSpace.XML", System.AppDomain.CurrentDomain.BaseDirectory));當然我們為了代碼的模塊化，可以封裝到一個方法中:
private static string GetXmlCommentsPath()
{
return $@"{System.AppDomain.CurrentDomain.BaseDirectory}\bin\GetDocumentation.XML";
}好吧，ok，我們知道了這個配置了。
那么我們需要再bin目錄下創建一個xml，推薦是項目名.xml.
4.那么接下來就是swaggerNet.cs配置.
using System;
using System.IO;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Dispatcher;
using System.Web.Routing;
using Swagger.Net;
[assembly: WebActivator.PreApplicationStartMethod(typeof(ThinkingSpace.App_Start.SwaggerNet), "PreStart")]
[assembly: WebActivator.PostApplicationStartMethod(typeof(ThinkingSpace.App_Start.SwaggerNet), "PostStart")]
namespace ThinkingSpace.App_Start
{
public static class SwaggerNet
{
public static void PreStart()
{
RouteTable.Routes.MapHttpRoute(
name: "SwaggerApi",
routeTemplate: "api/docs/{controller}",
defaults: new { swagger = true }
);
}
public static void PostStart()
{
var config = GlobalConfiguration.Configuration;
config.Filters.Add(new SwaggerActionFilter());
try
{
config.Services.Replace(typeof(IDocumentationProvider),
new XmlCommentDocumentationProvider(HttpContext.Current.Server.MapPath("~/bin/ThinkingSpace.XML")));
}
catch (FileNotFoundException)
{
throw new Exception("Please enable \"XML documentation file\" in project properties with default (bin\\ThinkingSpace.XML) value or edit value in App_Start\\SwaggerNet.cs");
}
}
}
}統一我們需要修改xml的位置即可。
注意
我們需要在webapi中只能存在一個get，否則會報錯，因為需要符合restful 標準。
一個controller中只能有一個HttpGet請求，多了就會報錯。建議減少重載方法，將其他Get方法分開
如果在swagger.config中加上c.ResolveConflictingActions(apiDescriptions => apiDescriptions.First());則會只顯示第一個get方法
另：可以不安裝swagger ui for .net，安了有可能會報錯
看完了這篇文章，相信你對c# webapi如何配置swagger有了一定的了解，想了解更多相關知識，歡迎關注億速云行業資訊頻道，感謝各位的閱讀！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
