Adding swagger

Question

Adding swagger

Rajarajacholan Krishnamurthy 31

Even though I have added AddSwaggerGen in ConfigureService, Why I am still getting the error message:

Be sure that the Startup.cs for your application is calling AddSwaggerGen from within ConfigureServices in order to generate swagger

 public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "HPlusSports API",
                    Version = "1.0",
                    Description = "Product API for HPlusSports"
                });
            });
        }

AgaveJoe 30,126 Reputation points

2023-08-17T11:55:23.1+00:00
Is the HTTP pipeline configured to use Swagger?

app.UseSwagger(); app.UseSwaggerUI();

Visual Studio ASP.NET Core 5+ templates generates the Swagger configuration for the development environment. The following if from the ASP.NET Core 5 template, which by the way, is out of support.

if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); app.UseSwagger(); app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApi5 v1")); }

Maybe the environment where the application is running is not development?
Anonymous

2023-08-21T02:02:47.71+00:00

Hi @Rajarajacholan Krishnamurthy

Which version of Swashbuckle.AspNetCore package you are using? And can you tell us whether your application works well on the local environment or not, whether this issue happens on local development environment or publish environment? If possible, can you share the whole Startup.cs, or create a simple sample to reproduce the problem?

Rajarajacholan Krishnamurthy 31

SwashBuckle.AspNetCore 5.3.1 and the app is running fine on my local.

Here's the entire startup.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.HttpsPolicy;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Microsoft.Extensions.Logging;
using Microsoft.OpenApi.Models;

namespace HPlusSportsAPI
{
    public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        // This method gets called by the runtime. Use this method to add services to the container.
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddControllers();
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo
                {
                    Title = "HPlusSports API",
                    Version = "1.0",
                    Description = "Product API for HPlusSports"
                });
            });
        }

        // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
        public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            app.UseSwagger();

            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json",
                    "HPlus Sports");
            });
            app.UseHttpsRedirection();

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
    }
}

1 answer

Your answer

AgaveJoe 30,126 Reputation points

2023-08-17T11:55:23.1+00:00

Is the HTTP pipeline configured to use Swagger?

app.UseSwagger(); app.UseSwaggerUI();

Visual Studio ASP.NET Core 5+ templates generates the Swagger configuration for the development environment. The following if from the ASP.NET Core 5 template, which by the way, is out of support.

if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); app.UseSwagger(); app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApi5 v1")); }

Maybe the environment where the application is running is not development?
Anonymous

2023-08-21T02:02:47.71+00:00

Hi @Rajarajacholan Krishnamurthy

Which version of Swashbuckle.AspNetCore package you are using? And can you tell us whether your application works well on the local environment or not, whether this issue happens on local development environment or publish environment? If possible, can you share the whole Startup.cs, or create a simple sample to reproduce the problem?
Rajarajacholan Krishnamurthy 31 Reputation points

2023-08-22T13:09:30.19+00:00

SwashBuckle.AspNetCore 5.3.1 and the app is running fine on my local.

Here's the entire startup.cs

using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.AspNetCore.HttpsPolicy; using Microsoft.AspNetCore.Mvc; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; using Microsoft.OpenApi.Models; namespace HPlusSportsAPI { public class Startup { public Startup(IConfiguration configuration) { Configuration = configuration; } public IConfiguration Configuration { get; } // This method gets called by the runtime. Use this method to add services to the container. public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "HPlusSports API", Version = "1.0", Description = "Product API for HPlusSports" }); }); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "HPlus Sports"); }); app.UseHttpsRedirection(); app.UseRouting(); app.UseAuthorization(); app.UseEndpoints(endpoints => { endpoints.MapControllers(); }); } } }

Answer 1

Rajarajacholan Krishnamurthy 31

Strangely, the deployed API works though getting publish error! Just got confused on the error message!

Anonymous

2023-08-24T02:24:02.9266667+00:00

Can't reproduce the problem, I created a new Asp.net core API application and use the SwashBuckle.AspNetCore 5.3.1 package and use your configuration. Then, the swagger works well on my local environment and IIS server, on the IIS server, I have to append the /swagger/Inde.html at the end of the request url manually. So, which kind of server you are using to host or deploy the application? You can try to publish the application again (with select the delete existing file option).

Share via

Adding swagger

1 answer

Your answer