C# Class NSwag.AspNetCore.SwaggerExtensions

Provides OWIN extensions to enable Swagger UI.

Public Methods

Method	Description
UseSwagger ( this app, Assembly webApiAssembly, SwaggerOwinSettings settings ) : IApplicationBuilder	Addes the Swagger generator and Swagger UI to the OWIN pipeline.
UseSwagger ( this app, IEnumerable webApiAssemblies, SwaggerOwinSettings settings ) : IApplicationBuilder	Addes the Swagger generator and Swagger UI to the OWIN pipeline.
UseSwagger ( this app, IEnumerable controllerTypes, SwaggerOwinSettings settings ) : IApplicationBuilder	Addes the Swagger generator to the OWIN pipeline.
UseSwagger ( this app, IEnumerable controllerTypes, SwaggerOwinSettings settings, SwaggerJsonSchemaGenerator schemaGenerator ) : IApplicationBuilder	Addes the Swagger generator to the OWIN pipeline.
UseSwaggerUi ( this app, Assembly webApiAssembly, SwaggerUiOwinSettings settings ) : IApplicationBuilder	Addes the Swagger generator and Swagger UI to the OWIN pipeline.
UseSwaggerUi ( this app, IEnumerable webApiAssemblies, SwaggerUiOwinSettings settings ) : IApplicationBuilder	Addes the Swagger generator and Swagger UI to the OWIN pipeline.
UseSwaggerUi ( this app, IEnumerable controllerTypes, SwaggerUiOwinSettings settings, SwaggerJsonSchemaGenerator schemaGenerator ) : IApplicationBuilder	Addes the Swagger generator and Swagger UI to the OWIN pipeline.
UseSwaggerUi ( this app, SwaggerUiOwinSettings settings ) : IApplicationBuilder	Addes the Swagger UI (only) to the OWIN pipeline.

Addes the Swagger generator and Swagger UI to the OWIN pipeline.

public static UseSwagger ( this app, Assembly webApiAssembly, SwaggerOwinSettings settings ) : IApplicationBuilder
app	this	The app.
webApiAssembly	System.Reflection.Assembly	The Web API assembly to search for controller types.
settings	SwaggerOwinSettings	The Swagger generator settings.
return	IApplicationBuilder

Addes the Swagger generator and Swagger UI to the OWIN pipeline.

public static UseSwagger ( this app, IEnumerable webApiAssemblies, SwaggerOwinSettings settings ) : IApplicationBuilder
app	this	The app.
webApiAssemblies	IEnumerable	The Web API assemblies to search for controller types.
settings	SwaggerOwinSettings	The Swagger generator settings.
return	IApplicationBuilder

Addes the Swagger generator to the OWIN pipeline.

public static UseSwagger ( this app, IEnumerable controllerTypes, SwaggerOwinSettings settings ) : IApplicationBuilder
app	this	The app.
controllerTypes	IEnumerable	The Web API controller types.
settings	SwaggerOwinSettings	The Swagger generator settings.
return	IApplicationBuilder

Addes the Swagger generator to the OWIN pipeline.

public static UseSwagger ( this app, IEnumerable controllerTypes, SwaggerOwinSettings settings, SwaggerJsonSchemaGenerator schemaGenerator ) : IApplicationBuilder
app	this	The app.
controllerTypes	IEnumerable	The Web API controller types.
settings	SwaggerOwinSettings	The Swagger generator settings.
schemaGenerator	SwaggerJsonSchemaGenerator	The schema generator.
return	IApplicationBuilder

Addes the Swagger generator and Swagger UI to the OWIN pipeline.

public static UseSwaggerUi ( this app, Assembly webApiAssembly, SwaggerUiOwinSettings settings ) : IApplicationBuilder
app	this	The app.
webApiAssembly	System.Reflection.Assembly	The Web API assembly to search for controller types.
settings	SwaggerUiOwinSettings	The Swagger UI and generator settings.
return	IApplicationBuilder

Addes the Swagger generator and Swagger UI to the OWIN pipeline.

public static UseSwaggerUi ( this app, IEnumerable webApiAssemblies, SwaggerUiOwinSettings settings ) : IApplicationBuilder
app	this	The app.
webApiAssemblies	IEnumerable	The Web API assemblies to search for controller types.
settings	SwaggerUiOwinSettings	The Swagger UI and generator settings.
return	IApplicationBuilder

Addes the Swagger generator and Swagger UI to the OWIN pipeline.

public static UseSwaggerUi ( this app, IEnumerable controllerTypes, SwaggerUiOwinSettings settings, SwaggerJsonSchemaGenerator schemaGenerator ) : IApplicationBuilder
app	this	The app.
controllerTypes	IEnumerable	The Web API controller types.
settings	SwaggerUiOwinSettings	The Swagger UI and generator settings.
schemaGenerator	SwaggerJsonSchemaGenerator	The schema generator.
return	IApplicationBuilder

Addes the Swagger UI (only) to the OWIN pipeline.

public static UseSwaggerUi ( this app, SwaggerUiOwinSettings settings ) : IApplicationBuilder
app	this	The app.
settings	SwaggerUiOwinSettings	The Swagger UI settings.
return	IApplicationBuilder