How can I change the default info title produced by nswag?

Question

I'm using NSwag for .NET Core 3.1. Everything works correctly.

I can't determine how to change "My Title" (which is the info title) to something else.

Here is the swagger page:

Here is my registration code:

app.UseOpenApi();
app.UseSwaggerUi3(c => c.DocumentTitle = "My Api");

Any help is very much appreciated. Thanks!

Julian · Accepted Answer · 2020-12-03T17:16:43.110

15

Just set the Title property when calling AddSwaggerDocument

public void ConfigureServices(IServiceCollection services)
{
    services.AddSwaggerDocument(settings =>
    {
        settings.Title = "My Own Title";
    });
}

edited Dec 03 '20 at 17:16

answered Apr 14 '20 at 11:49

Julian

33,915
22
119
174

score 6 · Answer 2 · edited Feb 18 '22 at 14:59

6

For NSwag

services.AddOpenApiDocument(document => {
   document.Title = "Your Title";
});

edited Feb 18 '22 at 14:59

mason

31,774
10
77
121

answered Jun 15 '21 at 17:10

Murali Krishna

97
1
4

Brando Zhang · Answer 3 · 2020-04-08T01:26:22.830

As far as I know, if you want to modify the nswagtitle. You should modify AddSwaggerDocument config setting in the ConfigureServices method as below:

Details you could refer to below codes:

        services.AddSwaggerDocument(config =>
        {
            config.PostProcess = document =>
            {
                //document.Info.Version = "v1";
                document.Info.Title = "ToDo API";
                //document.Info.Description = "A simple ASP.NET Core web API";
                //document.Info.TermsOfService = "None";
                //document.Info.Contact = new NSwag.OpenApiContact
                //{
                //    Name = "Shayne Boyer",
                //    Email = string.Empty,
                //    Url = "https://twitter.com/spboyer"
                //};
                //document.Info.License = new NSwag.OpenApiLicense
                //{
                //    Name = "Use under LICX",
                //    Url = "https://example.com/license"
                //};
            };

        });

Details startup.cs codes:

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Authentication.Negotiate;
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.Hosting;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;

namespace CoreNormalIssue
{
    public class Startup
    {
        // This method gets called by the runtime. Use this method to add services to the container.
        // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940
        public void ConfigureServices(IServiceCollection services)
        {

            services.AddAuthentication(NegotiateDefaults.AuthenticationScheme)
 .AddNegotiate();
            services.AddControllersWithViews();

            services.AddSwaggerDocument(config =>
            {
                config.PostProcess = document =>
                {
                    //document.Info.Version = "v1";
                    document.Info.Title = "ToDo API";
                    //document.Info.Description = "A simple ASP.NET Core web API";
                    //document.Info.TermsOfService = "None";
                    //document.Info.Contact = new NSwag.OpenApiContact
                    //{
                    //    Name = "Shayne Boyer",
                    //    Email = string.Empty,
                    //    Url = "https://twitter.com/spboyer"
                    //};
                    //document.Info.License = new NSwag.OpenApiLicense
                    //{
                    //    Name = "Use under LICX",
                    //    Url = "https://example.com/license"
                    //};
                };
            });


        }

        // 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.UseStaticFiles();
            app.UseRouting();
            app.UseAuthorization();
            app.UseOpenApi();
            app.UseSwaggerUi3();




            app.UseEndpoints(endpoints =>
            {               
                endpoints.MapControllerRoute(
                        name: "default",
                        pattern: "{controller=Default}/{action=Index}/{id?}");             
            });
        }
    }
}

Result:

score 3 · Answer 4 · answered May 12 '22 at 23:19

For anyone who landed here while searching for how to do this in .NET 6...

If you check "Enable OpenAPI support" when creating a .NET 6 Web API project, you get a template with some basic Swagger config. I don't think any of the existing answers are applicable to that template. If there's a simpler way to do this in a .NET 6 project, I'd appreciate an edit.

Create a class that implements IDocumentFilter:

public class TitleFilter : IDocumentFilter
{
    public void Apply(OpenApiDocument doc, DocumentFilterContext context)
    {
        doc.Info.Title = "My Title";
    }
}

Add your document filter to the SwaggerGenOptions:

builder.Services.AddSwaggerGen(o => o.DocumentFilter<TitleFilter>());

I used something like this: builder.Services.AddSwaggerGen(o => o.SwaggerDoc("v1", new OpenApiInfo { Title = "My Title" })); — DSXP, May 27 '22 at 14:53

How can I change the default info title produced by nswag?

4 Answers4