Skip to content
Rico Suter edited this page Apr 26, 2018 · 138 revisions

Roadmap | SDK Development | Contribute

Ways to use the toolchain

Automated/CLI:

ASP.NET (Core) Middlewares:

GUI:

Tutorials

The Swagger/OpenAPI document

Swagger Generation

Available Swagger generators:

The Swagger generators use the JSON Schema generator from the NJsonSchema project:

  • JsonSchemaGenerator (NJsonSchema): Generates schemas from .NET classes
  • XML Documentation (NJsonSchema)
    • The NSwag.AspNetCore NuGet package automatically installs the required NuGet packages for reading XML Documentation.
  • Enums (NJsonSchema)
  • Inheritance (NJsonSchema): How to describe and generate inheritance of DTO classes.

Customizations

Swagger generation:

You can customize the Swagger generator with the following extension points of NSwag:

Schema processing:

  • Type Mappers (NJsonSchema): Type mappers allow you to generate a custom JSON Schema for a given .NET type.
  • Schema Processors (NJsonSchema): Post process the generation of the schema or child schemas
  • Schema Name Generators (NJsonSchema): Customize the names of schema 'definitions' keys.

Code Generation

Available code generators:

Customizations: