Class ApiVersionProcessor

Namespace

NSwag.Generation.Processors

Assembly

NSwag.Generation.dll

An operation processor which replaces {version:apiVersion} route placeholders and filters the included versions.

public class ApiVersionProcessor : IOperationProcessor

Inheritance

object

ApiVersionProcessor

Implements

IOperationProcessor

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ApiVersionProcessor()

public ApiVersionProcessor()

Properties

IgnoreParameter

Gets or sets a value indicating whether to ignore the global API version parameter (ASP.NET Core only, default: true).

public bool IgnoreParameter { get; set; }

Property Value

bool

IncludedVersions

Gets or sets the list of versions which should be included in the generated document (leave empty to include all versions).

public string[] IncludedVersions { get; set; }

Property Value

string[]

Methods

Process(OperationProcessorContext)

Processes the specified method information.

public bool Process(OperationProcessorContext context)

Parameters

context OperationProcessorContext

The processor context.

Returns

bool

true if the operation should be added to the Swagger specification.