Class DocumentProcessorContext

Namespace

NSwag.Generation.Processors.Contexts

Assembly

NSwag.Generation.dll

The IDocumentProcessor context.

public class DocumentProcessorContext

Inheritance

object

DocumentProcessorContext

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DocumentProcessorContext(OpenApiDocument, IEnumerable<Type>, IEnumerable<Type>, JsonSchemaResolver, JsonSchemaGenerator, OpenApiDocumentGeneratorSettings)

Initializes a new instance of the DocumentProcessorContext class.

public DocumentProcessorContext(OpenApiDocument document, IEnumerable<Type> allControllerTypes, IEnumerable<Type> controllerTypes, JsonSchemaResolver schemaResolver, JsonSchemaGenerator schemaGenerator, OpenApiDocumentGeneratorSettings settings)

Parameters

document OpenApiDocument

The document.

allControllerTypes IEnumerable<Type>

The controller types.

controllerTypes IEnumerable<Type>

The controller types.

schemaResolver JsonSchemaResolver

The schema resolver.

schemaGenerator JsonSchemaGenerator

The schema generator.

settings OpenApiDocumentGeneratorSettings

The settings.

Properties

AllControllerTypes

Gets the all controller types even the excluded/ignored ones.

public IEnumerable<Type> AllControllerTypes { get; }

Property Value

IEnumerable<Type>

ControllerTypes

Gets the controller types which have actually been used for operation generation.

public IEnumerable<Type> ControllerTypes { get; }

Property Value

IEnumerable<Type>

Document

Gets the Swagger document.

public OpenApiDocument Document { get; }

Property Value

OpenApiDocument

SchemaGenerator

Gets the schema generator (call Generate() with JsonSchemaResolver property!).

public JsonSchemaGenerator SchemaGenerator { get; }

Property Value

JsonSchemaGenerator

SchemaResolver

Gets or sets the schema resolver.

public JsonSchemaResolver SchemaResolver { get; }

Property Value

JsonSchemaResolver

Settings

Gets the settings.

public OpenApiDocumentGeneratorSettings Settings { get; }

Property Value

OpenApiDocumentGeneratorSettings