How to redirect from root url to /swagger/ui/index?

Question

I have a WebApi project with Swashbuckle installed onto it.

In default setup, I must open in browser http://localhost:56131/swagger/ui/index to view my operations description and test page. I want it to be accessible from root of the site: http://localhost:56131/. How can I achieve this?

@Sampada no, I didn't. I believe that this can be solved with some web api redirect, and swagger is just my case. I paused this task for further research. — v.karbovnichy, Jun 16 '16 at 11:09
Did you have a look at my answer? Consider marking it as solution if it helped — Benjamin Soulier, Sep 06 '16 at 16:13
@bsoulier of course I did but I had no chance to test it yet, sorry. I'll definitely mark your answer as such when I test it. — v.karbovnichy, Sep 06 '16 at 17:03
You can view the url - http://stackoverflow.com/questions/30028736/how-to-use-swagger-as-welcome-page-of-iappbuilder-in-webapi — Silly John, Oct 10 '16 at 21:07

score 31 · Accepted Answer · edited Sep 15 '17 at 06:27

31

Influenced by this answer to similar question, slightly modified code:

public class WebApiConfig
{
    public static void Configure(IAppBuilder app)
    {
        var httpConfig = new HttpConfiguration();

        // Attribute routing
        config.MapHttpAttributeRoutes();

        // Redirect root to Swagger UI
        config.Routes.MapHttpRoute(
            name: "Swagger UI",
            routeTemplate: "",
            defaults: null,
            constraints: null,
            handler: new RedirectHandler(SwaggerDocsConfig.DefaultRootUrlResolver, "swagger/ui/index"));

        // Configure OWIN with this WebApi HttpConfiguration
        app.UseWebApi(httpConfig);
    }
}

This way it is not necessary to create new WebAPI controller as so did @bsoulier in his answer.

This solution is based on already existing class RedirectHandler in Swashbuckle.Core assembly.

edited Sep 15 '17 at 06:27

Sergey Shuvalov

1,980
2
15
19

answered Dec 22 '16 at 11:28

v.karbovnichy

2,735
2
29
43

Glad you pointed out the .trim('/') - I missed this first time around! – Karl Gjertsen Jul 08 '17 at 11:27
What about Asp.net Core? – Syaiful Nizam Yahya Mar 14 '18 at 02:51
@SyaifulNizamYahya try this solution for ASP.NET Core: https://stackoverflow.com/a/44912390/1875339 – v.karbovnichy Mar 18 '18 at 07:43

score 10 · Answer 2 · answered Jul 27 '16 at 13:54

10

If you for sure use a Web API project, you can:

enable Http Attribute Routing,
create the following method within an existing or new controller:

[Route(""), HttpGet]
[ApiExplorerSettings(IgnoreApi = true)]
public HttpResponseMessage RedirectToSwaggerUi()
{
    var httpResponseMessage = new HttpResponseMessage(HttpStatusCode.Found);
    httpResponseMessage.Headers.Location = new Uri("/swagger/ui/index", UriKind.Relative);
    return httpResponseMessage;
}

Note the use of ApiExplorerSettings attribute, so that it doesn't show up in the Swagger definition.

answered Jul 27 '16 at 13:54

Benjamin Soulier

1,975
1
16
27

How to enable Http Attribute Routing? Install-Package Microsoft.AspNet.WebApi.WebHost in Package Manager Console doesnt seems to do the trick. – Syaiful Nizam Yahya Mar 14 '18 at 02:14
config.MapHttpAttributeRoutes() – Benjamin Soulier Mar 19 '18 at 18:23
1

Perfect! This worked better for me as I already have some weird routes in my RouteConfig and preferred to not touch that. – dst3p Apr 20 '18 at 16:15

Gunnar Siréus · Answer 3 · 2018-03-18T10:11:13.283

4

Even simpler variant of the above answer:

public class DefaultController : Controller
{
    [Route(""), HttpGet]
    [ApiExplorerSettings(IgnoreApi = true)]
    public RedirectResult RedirectToSwaggerUi()
    {
        return Redirect("/swagger/");
    }
}

The simpler, the better! This one works for me.

edited Mar 18 '18 at 10:11

answered Mar 18 '18 at 10:05

Gunnar Siréus

74
5

score 2 · Answer 4 · answered May 05 '20 at 15:33

For a RESTFUL API in ASP Net Core > 2.2, ,set the default URL in Project/Properties/ Debug

And launchSettings.json will be automaticlly updated:

"profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "swagger/index.html",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },

score 1 · Answer 5 · edited Jan 07 '19 at 07:48

For .net core in the properties launchsettings.json modify profiles and api sections to point to swagger.

profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true,
      "launchUrl": "api/swagger",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "authapi": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "api/swagger",
      "applicationUrl": "https://localhost:5001;http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }

It would be helpful if you edit this answer to use a preformatted text block. — icirellik, Jan 07 '19 at 03:26

score 0 · Answer 6 · answered Aug 23 '18 at 15:50

0

if the task allows you, in _layout.chtml just add follow line to head:

<meta http-equiv="refresh" content="0; URL='/swagger'" />

this will redirect you on swagger/index after page was loaded

answered Aug 23 '18 at 15:50

VanavaraVL

1

1

As you can see, this question is for WebAPI, no html content are served there – v.karbovnichy Aug 23 '18 at 15:52

score 0 · Answer 7 · answered Jan 09 '19 at 04:46

0

Change the value of launchUrl = "swagger/index.html" in launchSetting.Json in asp.net core 2.1/2.2

"ProjectName": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "swagger/index.html",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      },
      "applicationUrl": "http://localhost:44333"
    }

answered Jan 09 '19 at 04:46

San Jaisy

9,586
15
93
162

1

Does this setting get copied to the publish directory? It doesn't appear to work for anything but development... – 2b77bee6-5445-4c77-b1eb-4df3e5 Jul 12 '19 at 12:48

Ifeanyilawrence · Answer 8 · 2019-06-17T16:39:59.017

-1

If you are running dotnet core, just goto properties->launchsettings.json and comment out or remove the launchUrl and set the swagger RoutePrefix to string.Empty.

edited Jun 17 '19 at 16:39

answered Jun 14 '19 at 15:16

Ifeanyilawrence

21
4

How to redirect from root url to /swagger/ui/index?

8 Answers8

Linked