Skip to main content

OpenApiFeature

Assembly: ServiceStack.Api.OpenApi.dll
View Source
Declaration
public class OpenApiFeature : IPlugin, IPreInitPlugin, IHasStringId, IHasId<string>

Properties

Id

View Source
Declaration
public string Id { get; set; }

ResourceFilterPattern

Gets or sets System.Text.RegularExpressions.Regex pattern to filter available resources.

View Source
Declaration
public string ResourceFilterPattern { get; set; }

UseCamelCaseSchemaPropertyNames

View Source
Declaration
public bool UseCamelCaseSchemaPropertyNames { get; set; }

UseLowercaseUnderscoreSchemaPropertyNames

View Source
Declaration
public bool UseLowercaseUnderscoreSchemaPropertyNames { get; set; }

DisableAutoDtoInBodyParam

View Source
Declaration
public bool DisableAutoDtoInBodyParam { get; set; }

LogoUrl

View Source
Declaration
public string LogoUrl { get; set; }

LogoHref

View Source
Declaration
public string LogoHref { get; set; }

ApiDeclarationFilter

View Source
Declaration
public Action<OpenApiDeclaration> ApiDeclarationFilter { get; set; }

OperationFilter

Operation filter. Action takes a verb and operation as parameters

View Source
Declaration
public Action<string, OpenApiOperation> OperationFilter { get; set; }

SchemaFilter

View Source
Declaration
public Action<OpenApiSchema> SchemaFilter { get; set; }

SchemaPropertyFilter

View Source
Declaration
public Action<OpenApiProperty> SchemaPropertyFilter { get; set; }

Tags

View Source
Declaration
public List<OpenApiTag> Tags { get; set; }

AnyRouteVerbs

View Source
Declaration
public List<string> AnyRouteVerbs { get; set; }

InlineSchemaTypesInNamespaces

View Source
Declaration
public List<string> InlineSchemaTypesInNamespaces { get; set; }

DisableSwaggerUI

View Source
Declaration
public bool DisableSwaggerUI { get; set; }

SecurityDefinitions

View Source
Declaration
public Dictionary<string, OpenApiSecuritySchema> SecurityDefinitions { get; set; }

OperationSecurity

View Source
Declaration
public Dictionary<string, List<string>> OperationSecurity { get; set; }

UseBearerSecurity

View Source
Declaration
public bool UseBearerSecurity { set; }

UseBasicSecurity

View Source
Declaration
public bool UseBasicSecurity { set; }

IsEnabled

View Source
Declaration
public static bool IsEnabled { get; }

Methods

BeforePluginsLoaded(IAppHost)

View Source
Declaration
public void BeforePluginsLoaded(IAppHost appHost)
Parameters
TypeName
ServiceStack.IAppHostappHost

Register(IAppHost)

View Source
Declaration
public void Register(IAppHost appHost)
Parameters
TypeName
ServiceStack.IAppHostappHost

Implements