如何在 WebAPI 中使用 Swagger 作为 IAppBuilder 的欢迎页面

Question

我尝试将 Swagger 与 Microsoft WebAPI 2 一起使用。

目前，我在一个方法中进行了以下调用。

appBuilder
   .ConfigureOAuth()
   .UseWebApi(configuration)
   .UseWelcomePage();

如果我想使用 Swagger，我必须使用这个 url “https://localhost:44300/swagger” 哪个效果很好。

我希望我的主页重定向到我招摇的url，也许如下但这个示例不起作用。

    appBuilder
       ...
       .UseWelcomePage("/swagger");

有什么想法吗？

Answer 1

好的，这是一种方法。添加一个新的 MVC 控制器 (Not Web API) 例如 HomeController 并在 Index 操作中添加以下代码：

using System.Web.Mvc;

namespace Kids.Math.Api.Controllers
{
public class HomeController : Controller
{
    public ActionResult Index()
    {
        return new RedirectResult("~/swagger/ui/index");
    }


}

}

此外，请确保您的路由配置具有以下内容（请注意，默认情况下它已经具有）

        public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            name: "Default",
            url: "{controller}/{action}/{id}",
            defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
        );
    }

Answer 2

在 Configuration(IAppBuilder app) 方法的 Startup.cs 文件中，我使用这行代码使其在加载时重定向到 swagger 欢迎页面。

app.Run(async context => { 
    context.Response.Redirect("swagger/ui/index"); 
});

所以我使用的完整方法如下

[assembly: OwinStartup(typeof(AtlasAuthorizationServer.Startup))]
namespace AtlasAuthorizationServer
{
    public partial class Startup
    {
        public void Configuration(IAppBuilder app)
        {
            ConfigureAuth(app);

            HttpConfiguration config = new HttpConfiguration();
            WebApiConfig.Register(config);
            app.UseWebApi(config);

            app.Run(async context => {
                context.Response.Redirect("swagger/ui/index");
            });
        }
    }
}

请注意，这将在 visual studio 中引起绿色警告。我确信有一些方法可以通过函数中的 await 调用将其模拟为异步。

Answer 3

我有类似的问题，我通过自定义 SwaggerUI url 解决了它。这是我的配置方法：

public void Configuration(IAppBuilder app)
{
    var thisAssembly = typeof (Startup).Assembly;

    HttpConfiguration httpConfig = new HttpConfiguration();

    app.MapHttpAttributeRoutes();
    app.UseCors(CorsOptions.AllowAll);
    app.UseWebApi(httpConfig);

    httpConfig
        .EnableSwagger("api/{apiVersion}",c =>
        {
            c.IncludeXmlComments(string.Format(@"{0}\bin\Docs.xml", AppDomain.CurrentDomain.BaseDirectory));
            c.SingleApiVersion("v1", "My API");
        })
        .EnableSwaggerUi("{*assetPath}",c =>
        {
            c.CustomAsset("index", thisAssembly, "AspNetIdentity.WebApi.DocsAssets.index.html");
        });

    httpConfig.Routes.First(x => x.RouteTemplate == "{*assetPath}").Defaults["assetPath"] = "index";
}

这样，当您转到 localhost:44300 时，您会看到 Swagger UI 作为启动页面。

Answer 4

我通过在 RouteConfig.cs 中添加一条路线来实现我想要的效果，如下所示：

    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapHttpRoute(
            name: "swagger_root", 
            routeTemplate: "", 
            defaults: null, 
            constraints: null,
            handler: new RedirectHandler((message => message.RequestUri.ToString()), "swagger"));

        routes.MapRoute(
            name: "Default",
            url: "{controller}/{action}/{id}",
            defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
        );
    }

查看来自 swashbuckle 的这段代码，看看发生了什么：https://github.com/domaindrivendev/Swashbuckle/blob/master/Swashbuckle.Core/Application/RedirectHandler.cs

Answer 5

对于Asp.Net核心使用这个：

app.Run(context => {
            context.Response.Redirect("swagger/ui");
            return Task.CompletedTask;
        });

Answer 6

为 ASP.NET 核心创建了以下拉取请求： https://github.com/domaindrivendev/Swashbuckle.AspNetCore/pull/486

同时可以使用以下解决方法：

public static IApplicationBuilder UseSwaggerUI(
        this IApplicationBuilder app,
        Action<SwaggerUIOptions> setupAction)
    {
        var options = new SwaggerUIOptions();
        setupAction?.Invoke(options);

        // This method reads an internal property value 
        // http://dotnetfollower.com/wordpress/2012/12/c-how-to-set-or-get-value-of-a-private-or-internal-property-through-the-reflection/
        var indexSettings = options.GetPropertyValue<IndexSettings>("IndexSettings");
        // Serve swagger-ui assets with the FileServer middleware, using a custom FileProvider
        // to inject parameters into "index.html"
        var fileServerOptions = new FileServerOptions
        {
            RequestPath = string.IsNullOrWhiteSpace(options.RoutePrefix) ? string.Empty : $"/{options.RoutePrefix}",
            FileProvider = new SwaggerUIFileProvider(indexSettings.ToTemplateParameters()),
            EnableDefaultFiles = true,
            StaticFileOptions =
            {
                ContentTypeProvider = new FileExtensionContentTypeProvider()
            }
        };
        app.UseFileServer(fileServerOptions);

        return app;
    }

干杯

Answer 7

在ASP.NET Core中，您可以简单地在将SwaggerUI注册为空字符串时更改RoutePrefix。

app.UseSwaggerUI(c =>
{
    c.RoutePrefix = "";
    ...
};

无需重定向配置，除非您仍希望在路径中使用 /swagger 或类似内容。

Answer 8

在 .Net Core 中，只需打开应用程序的属性，转到调试选项卡，然后在 "Launch browser" 文本框中写入 Swagger，

launch browser

Answer 9

您可以做什么，只需将 Home Controller & Index Action 设置为默认值，然后按如下方式修改您的控制器操作：

public class HomeController : Controller
{
    // GET: /<controller>/
    public IActionResult Index()
    {
        return new RedirectResult("~/swagger");
    }
}

此问题的简短快速解决方案。

Answer 10

按照此处的示例：

https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-2.2&tabs=visual-studio

public class Startup {
   public void Configure(IApplicationBuilder app) {
      ...
      app.UseSwaggerUI( c => {
         c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
         c.RoutePrefix = string.Empty;
      });
      app.UseMvc(); // <-- must be after 
   }
}

在调用 app.UseSwaggerUI() 之后放置 app.UseMvc() 之前，我无法让它工作。

Answer 11

如果您是来这里寻找 asp.net 核心 2 答案的，您可以通过将 swagger 的 RoutePrefix 设置为应用根目录来实现相同的目的

app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My service");
                c.RoutePrefix = string.Empty;  // Set Swagger UI at apps root
            });

如何在 WebAPI 中使用 Swagger 作为 IAppBuilder 的欢迎页面

How to use Swagger as Welcome Page of IAppBuilder in WebAPI

c#

swagger

asp.net-web-api2