How to redirect root to swagger in Asp.Net Core 2.x?

Question

I'm building Asp.Net Core 2.x web api integrated with Swagger. To access the swagger, I had to append /swagger to the url, eg. https://mywebapi.azurewebsites.net/swagger/

How can I redirect https://mywebapi.azurewebsites.net/ to https://mywebapi.azurewebsites.net/swagger/ ?

score 33 · Accepted Answer · answered Mar 15 '18 at 02:34

Install Microsoft.AspNetCore.Rewrite from Nuget

In Startup.cs

public void Configure(IApplicationBuilder app, IHostingEnvironment env)

before

app.UseMvc();

add

var option = new RewriteOptions();
option.AddRedirect("^$", "swagger");
app.UseRewriter(option);

score 27 · Answer 2 · answered Aug 06 '18 at 20:37

27

In Startup.cs

 public void Configure(IApplicationBuilder app, IHostingEnvironment env)

You should have section where you set Swagger UI options. Add and set the RoutePrefix option to an empty string.

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

answered Aug 06 '18 at 20:37

Dmitriy B

270
3
4

2

this is setting a route prefix to the swagger, rather than redirecting to the actual swagger root. You actually have to change in launchSettings.json -> launchUrl – nkalfov Dec 11 '18 at 14:38

score 8 · Answer 3 · answered Mar 15 '18 at 11:14

8

Create a default controller like this:

using Microsoft.AspNetCore.Mvc;

namespace Api
{
    [ApiExplorerSettings(IgnoreApi = true)]
    public class DefaultController : Controller
    {
        [Route("/")]
        [Route("/docs")]
        [Route("/swagger")]
        public IActionResult Index()
        {
            return new RedirectResult("~/swagger");
        }
    }
}

Any url "/", "/docs" or "/swagger" is redirect to "/swagger".

answered Mar 15 '18 at 11:14

George Paoli

1,615
1
19
25

still goes to `/api/values` after adding this? – Piotr Kula Nov 28 '18 at 10:34
In my case, I changed the redirect URL a bit (return new RedirectResult("~/swagger/index.html"); ) and it worked perfectly. Chrome was throwing "Too many redirects" error when URL was only "~/swagger" without index.html (you can know the reason if you analyze for a moment). – Prateek Kumar Dalbehera Dec 24 '19 at 20:11
Nice and clean solution, tested with .NET Core 3.1 – Filip Golewski Mar 03 '21 at 22:56

score 6 · Answer 4 · answered Sep 17 '18 at 13:29

6

On Startup.cs, after:

app.UseSwaggerUI(options =>
                  {
                      options.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");

add :

options.RoutePrefix = string.Empty;

this will make your root url the main api url.

answered Sep 17 '18 at 13:29

ArlanG

415
5
10

In Properties folder, if I didn't set in launchSettings.json under "profiles" "launchUrl" values to "" (empty string) this above didn't work for me. Now I have this - "launchUrl": "" and it works. – SushiDynamite Aug 04 '20 at 08:50

score 1 · Answer 5 · answered Jul 12 '18 at 11:51

Open the launchSettings.json file.
Under the "profiles" node depending on your setup you should have one or more profiles. In may case I had "IIS Express" and another with named with my project name (e.g WebApplication1 ), now changing the launchUrl entry to "launchUrl": "swagger" solved my problem.
If this does not work and you have other profiles do the same and test.

score 1 · Answer 6 · answered Oct 13 '18 at 14:19

1

I have modified the launchSettings.json with "launchUrl": "swagger" instead of "launchUrl": "api/values"

work for me, if that doesnt work for you remove the c.RoutePrefix = string.Empty; from your app.UseSwaggerUI configuration.

answered Oct 13 '18 at 14:19

Franco Morales

31
8

How to redirect root to swagger in Asp.Net Core 2.x?

6 Answers6

Linked