How to change base url of Swagger in ASP.NET core

Question

By default when you enable swagger in ASP.NET Core project it's available on url:

http://localhost:<random_port>/swagger/ui

I would like to use a different base url instead of /swagger/ui. How/where can i configure that?

I found that for older versions you can configure the RootUrl but there aren't similiar method in ASP.NET Core:

.EnableSwagger(c =>
{
    c.RootUrl(req => myCustomBasePath);
});

Let me know if it worked for you. – Danny van der Kraan Aug 26 '16 at 08:59 — Danny van der Kraan, Aug 26 '16 at 08:59

EspressoBeans · Answer 1 · 2019-05-20T20:57:21.640

For ASP.NET Core 2 (and using Swashbuckle.AspNetCore.Swagger -Version 4.0.1), a couple things can be done for a full configuration of changing the default swagger UI base URL.

If you want to add "mycoolapi" to the beginning of your default swagger UI URL, like this: http://<server>/mycoolapi/swagger, then do the following:

In your Startup.cs Configure method:

    app.UseSwagger(c =>
    {
        c.RouteTemplate = "mycoolapi/swagger/{documentname}/swagger.json";
    });


    app.UseSwaggerUI(c =>
    {
        c.SwaggerEndpoint("/mycoolapi/swagger/v1/swagger.json", "My Cool API V1");
        c.RoutePrefix = "mycoolapi/swagger";
    });

Then, if you currently have your launchSettings to launch browser at swagger UI upon startup (for development purposes), update your launchSettings.json file profiles section similarly:

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

what is your iisExpress applicationUrl value? .. I tried everything but for some reason I cannot make it to work .. In the end I want to host it in IIS ('http://localhost/appName/') — Learner, Oct 01 '19 at 12:10
This should be accepted anwser. Set RouteTemplate is a must now in .net core. It was different in .net framework. — Antonio Rodríguez, Aug 21 '20 at 06:32
SwaggerEndPoint part should be like below for relative usage. c.SwaggerEndpoint("v1/swagger.json", "My Cool API V1"); — kaya, Apr 07 '22 at 11:36

maxspan · Accepted Answer · 2020-07-11T23:50:39.510

76

The new swagger version provides you with a property called RoutePrefix.

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
    c.RoutePrefix = "docs";
});

Should work for .net core

edited Jul 11 '20 at 23:50

answered Apr 26 '17 at 22:34

maxspan

13,326
15
75
104

12

the `RoutePrefix` alone isn't enough if you want to use URL prefix like `/prefix/swagger/...` for both Swagger UI and swagger.json file. You also need to set `RouteTemplate` property. – Ivan Sveshnikov Dec 20 '19 at 14:32
1

@IvanSveshnikov Update: I think it works fine now on 2022 without the `RouteTemplate `. :) Thank you! :) – Omar Magdy Aug 03 '22 at 00:20
@OmarMagdy it doesn't work for me on NET 7 VS2022, I had to add RouteTemplate. – ClownCoder Aug 28 '23 at 15:05

score 6 · Answer 3 · answered Nov 11 '21 at 04:32

6

Other answers didn't work for me in .NET 5. Here is how I added 'docs' to the route

app.UseSwagger(c => c.RouteTemplate = "/swagger/docs/{documentName}/swagger.json");
app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/docs/v2/swagger.json", "My API"));

answered Nov 11 '21 at 04:32

Boris Lipschitz

9,236
5
53
63

score 3 · Answer 4 · answered Nov 14 '18 at 12:40

3

You can do this as well in Config

app.UseSwaggerUI(c =>
            {
                c.RoutePrefix = string.Empty;
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "MY API");
            });

answered Nov 14 '18 at 12:40

JB's

606
13
30

1

Congrats for posting exactly the same answer as the accepted one, but with the lines switched round ;-) – Robert Perry Jun 13 '22 at 19:04

score 2 · Answer 5 · answered Jul 12 '18 at 11:56

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 May 18 '21 at 13:31

I had to dig through the original docs because all the above solutions did not work. This code in Startup.cs is what is working for me:

app.UseSwagger();
app.UseSwaggerUI(c => {
    c.SwaggerEndpoint($"./v1/swagger.json", "SapWeb v1");
});

My site is a subsite in IIS. So, at first, I had to set PathBase:

app.UsePathBase($"{pathbase}");

Danny van der Kraan · Answer 7 · 2016-09-09T07:21:25.317

The UseSwaggerUi() extension method to enable the middleware in the Configure method of the StartUp class takes two variables. A baseRoute which is on swagger/ui by default, and swaggerUrl which is on swagger/v1/swagger.json by default. Simply provide a different baseRoute.

//Swagger will be available under '/api' url
app.UseSwaggerUi("api");

If people would like to learn more about configuring Swagger for ASP.NET Core, I've written a blogpost to get started: https://dannyvanderkraan.wordpress.com/2016/09/09/asp-net-core-1-0-web-api-automatic-documentation-with-swagger-and-swashbuckle/

How to change base url of Swagger in ASP.NET core

7 Answers7

Linked