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

JSON Schema generator

The NSwag Swagger generator uses the JSON Schema generator from the NJsonSchema project.

• XML Documentation (NJsonSchema)
  • The NSwag.AspNetCore NuGet package automatically installs the required NuGet packages for reading XML Documentation.
• Enums (NJsonSchema)
• Inheritance (NJsonSchema): Add custom properties to the generated JSON objects (e.g. "x-documentation-link").
• Type Mappers (NJsonSchema): Type mappers allow you to generate a custom JSON Schema for a given .NET type.

Code generators

• Type Name Generator

Classes

Package: NSwag.Core

• SwaggerService

Package: NSwag.CodeGeneration

• Swagger Generators:

  • WebApiToSwaggerGenerator: ASP.NET Web API to Swagger

• Code Generators:

  • SwaggerToTypeScriptClientGenerator: TypeScript Client
  • SwaggerToCSharpClientGenerator: CSharp Client
  • SwaggerToCSharpControllerGenerator: CSharp WebAPI Controllers (contract first/schema first development)

Package: NSwag.AssemblyLoader

• Swagger Generators:
  • WebApiAssemblyToSwaggerGenerator: ASP.NET Web API to Swagger
  • AssemblyTypeToSwaggerGenerator: Types from .NET assemblies