Has anyone worked with an Asp.net Core Web API project implementing API versioning in .Net 8.0 and successfully deployed it in IIS?

Question

Has anyone worked with an Asp.net Core Web API project implementing API versioning in .Net 8.0 and successfully deployed it in IIS?

Kesava Subhash Gullapudi 30

I've implemented API versioning using Asp.Net Core web API in .Net 8.0 Framework, and it works fine in the debugger with Swagger. But when I deploy my application using IIS, I get an error page saying "Page can't be found". How can I resolve this issue?

AgaveJoe 30,126 Reputation points

2024-02-03T12:20:29.1233333+00:00

We cannot see your code or IIS configuration. We can only guess what's wrong.
Kesava Subhash Gullapudi 30 Reputation points

2024-02-05T05:03:01.3233333+00:00

As of you said ! I can share sample git repository link , please ! Try to get out from my issue ..,(Deploy in IIS)

https://github.com/saideldah/api-versioining-dot-net-6.git

Sample snippets for API VERSIONING .., Clone it in VS 2K22

**Note ***
change framework as .Net 8.0

AgaveJoe 30,126

Again, we cannot see your code! I upgraded the project from .net 7 to .net 8. Then I moved the swagger configuration so it works when the application is not in debug mode.

// Configure the HTTP request pipeline.
//if (app.Environment.IsDevelopment())
//{
//    var apiVersionDescriptionProvider = app.Services.GetRequiredService<IApiVersionDescriptionProvider>();

//    app.UseSwagger();
//    app.UseSwaggerUI(options =>
//    {
//        foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions)
//        {
//            options.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json",
//                description.GroupName.ToUpperInvariant());
//        }
//    });
//}

var apiVersionDescriptionProvider = app.Services.GetRequiredService<IApiVersionDescriptionProvider>();

app.UseSwagger();
app.UseSwaggerUI(options =>
{
    foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions)
    {
        options.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json",
            description.GroupName.ToUpperInvariant());
    }
});

Published to IIS. Then access the swagger doc using the standard swagger path.

http://localhost:8089/swagger/index.html

It just works.... If you are still having problems then share your code not someone else's that we need to modify. Reference documentation Configuration in ASP.NET Core

Kesava Subhash Gullapudi 30 Reputation points

2024-02-12T06:43:58.02+00:00

Hi Joe, Thank you for sharing the snippets. I have a question regarding Swagger integration. Currently, when I mention Swagger in the access path, everything works fine. However, I'm wondering if there's a way to have Swagger load automatically without needing to explicitly mention it in the access path. Is this possible? Looking forward to your insights.
AgaveJoe 30,126 Reputation points

2024-02-12T11:10:41.3+00:00
I'm wondering if there's a way to have Swagger load automatically without needing to explicitly mention it in the access path. Is this possible?

I'm guessing the use case is when a browser accesses the root URL display the swagger documentation.
Create an MVC controller with attribute routing that redirects the browser.

public class HomeController : Controller { [Route(""), HttpGet] [ApiExplorerSettings(IgnoreApi = true)] public RedirectResult Index() { return Redirect("/swagger/"); } }
Bruce (SqlWork.com) 77,686 Reputation points Volunteer Moderator

2024-02-12T17:00:47.1633333+00:00
or just tell swagger not to use a route prefix and its the default:

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

1 answer

Your answer

AgaveJoe 30,126 Reputation points

2024-02-03T12:20:29.1233333+00:00

We cannot see your code or IIS configuration. We can only guess what's wrong.
Kesava Subhash Gullapudi 30 Reputation points

2024-02-05T05:03:01.3233333+00:00

As of you said ! I can share sample git repository link , please ! Try to get out from my issue ..,(Deploy in IIS)

https://github.com/saideldah/api-versioining-dot-net-6.git

Sample snippets for API VERSIONING .., Clone it in VS 2K22

**Note ***
change framework as .Net 8.0
AgaveJoe 30,126 Reputation points

2024-02-05T13:20:56.9966667+00:00

Again, we cannot see your code! I upgraded the project from .net 7 to .net 8. Then I moved the swagger configuration so it works when the application is not in debug mode.

// Configure the HTTP request pipeline. //if (app.Environment.IsDevelopment()) //{ // var apiVersionDescriptionProvider = app.Services.GetRequiredService<IApiVersionDescriptionProvider>(); // app.UseSwagger(); // app.UseSwaggerUI(options => // { // foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions) // { // options.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", // description.GroupName.ToUpperInvariant()); // } // }); //} var apiVersionDescriptionProvider = app.Services.GetRequiredService<IApiVersionDescriptionProvider>(); app.UseSwagger(); app.UseSwaggerUI(options => { foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions) { options.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", description.GroupName.ToUpperInvariant()); } });

Published to IIS. Then access the swagger doc using the standard swagger path.

http://localhost:8089/swagger/index.html

It just works.... If you are still having problems then share your code not someone else's that we need to modify. Reference documentation Configuration in ASP.NET Core
Kesava Subhash Gullapudi 30 Reputation points

2024-02-12T06:43:58.02+00:00

Hi Joe, Thank you for sharing the snippets. I have a question regarding Swagger integration. Currently, when I mention Swagger in the access path, everything works fine. However, I'm wondering if there's a way to have Swagger load automatically without needing to explicitly mention it in the access path. Is this possible? Looking forward to your insights.
AgaveJoe 30,126 Reputation points

2024-02-12T11:10:41.3+00:00

I'm wondering if there's a way to have Swagger load automatically without needing to explicitly mention it in the access path. Is this possible?

I'm guessing the use case is when a browser accesses the root URL display the swagger documentation.
Create an MVC controller with attribute routing that redirects the browser.

public class HomeController : Controller { [Route(""), HttpGet] [ApiExplorerSettings(IgnoreApi = true)] public RedirectResult Index() { return Redirect("/swagger/"); } }
Bruce (SqlWork.com) 77,686 Reputation points Volunteer Moderator

2024-02-12T17:00:47.1633333+00:00

or just tell swagger not to use a route prefix and its the default:

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

Answer 1

builder.Services.AddApiVersioning(config => { config.DefaultApiVersion = new ApiVersion(1, 0); config.AssumeDefaultVersionWhenUnspecified = true; config.ReportApiVersions = true; }); builder.Services.ConfigureOptions<ConfigureSwaggerOptions>(); if (app.Environment.IsDevelopment() || app.Environment.IsProduction()) { app.UseSwagger(); app.UseSwaggerUI(options => { var apiVersionDescriptionProvider = app.Services.GetRequiredService<IApiVersionDescriptionProvider>(); foreach (var description in apiVersionDescriptionProvider.ApiVersionDescriptions) { options.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", description.GroupName.ToUpperInvariant()); } }); }

Share via

Has anyone worked with an Asp.net Core Web API project implementing API versioning in .Net 8.0 and successfully deployed it in IIS?

1 answer

Your answer