Home

Ways to use the toolchain

• Command Line
• NSwagStudio
  • Swagger specification via URL or from a .NET assembly (no running web app needed)
• ASP.NET HTTP Middlewares
  • Swagger and Swagger UI OWIN and ASP.NET Core Middlewares
  • How to use the OWIN Middlewares in Global.asax
  • Enable full exception serialization
• MSBuild
• T4 templates

Tutorials

• Integrate the NSwag toolchain into your ASP.NET Web API project
• Generate an Angular 2 TypeScript client from an existing ASP.NET Web API web assembly

Swagger Core

• SwaggerDocument: The .NET class describing a Swagger specification

Swagger Generation

• WebApiToSwaggerGenerator: Generate a Swagger specification from Web API controller classes
• WebApiAssemblyToSwaggerGenerator: Generate a Swagger specification from a Web API assembly

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.
• Type Mappers (NJsonSchema): Type mappers allow you to generate a custom JSON Schema for a given .NET type.

Code Generation

• SwaggerToTypeScriptClientGenerator: Generate TypeScript clients
• SwaggerToCSharpClientGenerator: Generate CSharp clients
• SwaggerToCSharpControllerGenerator: Generate CSharp Web API controllers (contract first/schema first development)

Extension points:

• Type Name Generators