Unchase.Swashbuckle.AspNetCore.Extensions 1.0.0

Unchase Swashbuckle Asp.Net Core Extensions is a library contains a bunch of extensions (filters) for Swashbuckle.AspNetCore.

The project is developed and maintained by Nikolay Chebotov (Unchase).

Getting Started

To use the extensions:

1. First install the NuGet package:

Install-Package Unchase.Swashbuckle.AspNetCore.Extensions

2. In the ConfigureServices method of Startup.cs, inside your AddSwaggerGen call, enable whichever extensions (filters) you need:

// This method gets called by the runtime. Use this method to add services to the container.
public void ConfigureServices(IServiceCollection services)
{
    // Add framework services.
    services.AddMvc();

    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new Info { Title = "My API", Version = "v1" });
        
        options.SwaggerDoc("v1", new Info {Title = "My API", Version = "v2"});

        // Add filters to fix enums
        options.EnumsWithValuesFixFilters(true);

        // Include xml-comments from xml-file generated by project
        var filePath = Path.Combine(AppContext.BaseDirectory, "WebApi2.0-Swashbuckle.xml");
        options.IncludeXmlComments(filePath);
    });
}

Builds status

Features

• Add an output enums integer values with there strings like 0 = FirstEnumValue without a StringEnumConverter in swaggerUI and schema (by default enums will output only their integer values)

• Add description to each enum value that has an [Description] attribute in swaggerUI and schema

  In Swashbuckle SwaggerUI:

  

  In schema parameters:

  

  In schema definitions:

  

  To show enum values descriptions you should use [Description] attribute in your code:

  /// <summary>
  /// Title enum.
  /// </summary>
  [DataContract]
  public enum Title
  {
      /// <summary>
      /// None.
      /// </summary>
      [Description("None enum description")]
      [EnumMember]
      None = 0,
  
      /// <summary>
      /// Miss.
      /// </summary>
      [Description("Miss enum description")]
      [EnumMember]
      Miss,
  
      /// <summary>
      /// Mr.
      /// </summary>
      [Description("Mr enum description")]
      [EnumMember]
      Mr
  }
  

• Fix enum values in generated by NSwagStudio or Unchase OpenAPI Connected Service client classes:

  /// <summary>Sample Person title.
  /// 0 = None (None enum description)
  /// 1 = Miss (Miss enum description)
  /// 2 = Mr (Mr enum description)</summary>
  [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "9.13.35.0 (Newtonsoft.Json v11.0.0.0)")]
  public enum Title
  {
      None = 0,
  
      Miss = 1,
  
      Mr = 2,
  
  }
  
  [System.CodeDom.Compiler.GeneratedCode("NJsonSchema", "9.13.35.0 (Newtonsoft.Json v11.0.0.0)")]
  public enum SamplePersonRequestResponseTitle
  {
      None = 0,
  
      Miss = 1,
  
      Mr = 2,
  
  }
  

HowTos

• Add HowTos in a future
• ... request for HowTo you need

Roadmap

See the changelog for the further development plans and version history.

Feedback

Please feel free to add your request a feature or report a bug. Thank you in advance!

Thank me!

If you like what I am doing and you would like to thank me, please consider:

Thank you for your support!

Copyright © 2019 Nikolay Chebotov (Unchase) - Provided under the Apache License 2.0.