CODEWITHSUNDEEP
c#asp.net-coreswagger-ui
Mike
Mike

Reputation: 1268

api version value by default in swagger-ui

I have configure swagger in our asp.core wep-api project and its working perfectly fine.Now i am looking into solution when swagger-ui appears as shown below

https://i.sstatic.net/WFVxw.jpg

the api version part should be fill automatically as per configuration from code side.

        services.AddSwaggerGen(c =>
        {
            c.SwaggerDoc("v1", new Info
            {
                Version = "v1",
                Title = "My API",
                Contact = new Contact
                {
                    Name = "My Api",
                    Url = "https://109.com/"
                }
            });
            var security = new Dictionary<string, IEnumerable<string>>
            {
                {"Bearer", new string[] { }},
            };
            c.AddSecurityDefinition("Bearer", new ApiKeyScheme
            {
                Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
                Name = "Authorization",
                In = "header",
                Type = "apiKey"
            });
            c.AddSecurityRequirement(security);
        });

Upvotes: 12

Views: 14329

Answers (2)

Rena
Rena

Reputation: 36605

You need to add options.SubstituteApiVersionInUrl=true to tell swagger to replace the version in the controller route and configure the api version: 

services.AddApiVersioning(options => options.ReportApiVersions = true);
services.AddMvcCore()
    .AddJsonFormatters()
    .AddVersionedApiExplorer(
          options =>
          {
              ////The format of the version added to the route URL  
              options.GroupNameFormat = "'v'VVV";
              //Tells swagger to replace the version in the controller route  
              options.SubstituteApiVersionInUrl = true;
          });

Also you need to add this to your controller:

[Route("api/[controller]")]
[ApiVersion("1.0")]
[ApiController]

Upvotes: 3

user1672994
user1672994

Reputation: 10839

You need to install Microsoft.AspNetCore.Mvc.Versioning and Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer packages to enable the API versioning in Swagger.

You can check the additional details at here.

In ConfigureServices method define the versioning scheme as 

 services.AddVersionedApiExplorer(o =>
 {
      o.GroupNameFormat = "'v'VVV";
      o.SubstituteApiVersionInUrl = true;
 });
 services.AddApiVersioning(config =>
 {
     config.DefaultApiVersion = new ApiVersion(1, 0);
     config.AssumeDefaultVersionWhenUnspecified = true;
     config.ReportApiVersions = true;
 });

Upvotes: 18

Related Questions