Class SwaggerOptions

public class SwaggerOptions

Inherited Members: object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods: SwaggerOptionsExtensions.SetCustomDocumentSerializer<TDocumentSerializer>(SwaggerOptions, params object[])

Constructors

public SwaggerOptions()

Gets or sets an optional custom ISwaggerDocumentSerializer implementation to use to serialize Swagger documents.

public ISwaggerDocumentSerializer CustomDocumentSerializer { get; set; }

For the CLI tool to be able to use this, this needs to be configured for use in the service collection of your application.

Actions that can be applied to an OpenApiDocument before it's serialized. Useful for setting metadata that's derived from the current request.

public List<Action<OpenApiDocument, HttpRequest>> PreSerializeFilters { get; }

Sets a custom route for the Swagger JSON/YAML endpoint(s). Must include the {documentName} parameter

public string RouteTemplate { get; set; }

Return Swagger JSON/YAML in the V2 format rather than V3

public bool SerializeAsV2 { get; set; }