public class OpenApiFeature extends org.apache.cxf.feature.DelegatingFeature<OpenApiFeature.Portable> implements org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupport, org.apache.cxf.jaxrs.common.openapi.SwaggerProperties
| Modifier and Type | Class and Description |
|---|---|
static class |
OpenApiFeature.Portable |
enabledSUPPORT_UI_PROPERTYCONTACT_PROPERTY, DEFAULT_LICENSE_URL, DEFAULT_LICENSE_VALUE, DEFAULT_PROPS_LOCATION, DESCRIPTION_PROPERTY, FILTER_CLASS_PROPERTY, LICENSE_PROPERTY, LICENSE_URL_PROPERTY, PRETTY_PRINT_PROPERTY, RESOURCE_PACKAGE_PROPERTY, TERMS_URL_PROPERTY, TITLE_PROPERTY, VERSION_PROPERTY| Constructor and Description |
|---|
OpenApiFeature() |
getDelegate, initialize, initialize, initialize, initialize, initializeProvider, setDelegatedoInitializeProvider, getActive, getID, isEnabledclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic boolean isScan()
public void setScan(boolean scan)
public String getFilterClass()
public void setFilterClass(String filterClass)
public String getVersion()
public void setVersion(String version)
public String getTitle()
public void setTitle(String title)
public String getDescription()
public void setDescription(String description)
public String getContactName()
public void setContactName(String contactName)
public String getContactEmail()
public void setContactEmail(String contactEmail)
public String getContactUrl()
public void setContactUrl(String contactUrl)
public String getLicense()
public void setLicense(String license)
public String getLicenseUrl()
public void setLicenseUrl(String licenseUrl)
public String getTermsOfServiceUrl()
public void setTermsOfServiceUrl(String termsOfServiceUrl)
public boolean isReadAllResources()
public void setReadAllResources(boolean readAllResources)
public Collection<String> getIgnoredRoutes()
public void setIgnoredRoutes(Collection<String> ignoredRoutes)
public boolean isPrettyPrint()
public void setPrettyPrint(boolean prettyPrint)
public boolean isRunAsFilter()
public Boolean isSupportSwaggerUi()
isSupportSwaggerUi in interface org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupportpublic void setSupportSwaggerUi(Boolean supportSwaggerUi)
public String getSwaggerUiVersion()
public void setSwaggerUiVersion(String swaggerUiVersion)
public String getSwaggerUiMavenGroupAndArtifact()
public void setSwaggerUiMavenGroupAndArtifact(String swaggerUiMavenGroupAndArtifact)
public Map<String,String> getSwaggerUiMediaTypes()
getSwaggerUiMediaTypes in interface org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupportpublic String getConfigLocation()
public void setConfigLocation(String configLocation)
public String getPropertiesLocation()
public void setPropertiesLocation(String propertiesLocation)
public void setRunAsFilter(boolean runAsFilter)
public void setScanKnownConfigLocations(boolean scanKnownConfigLocations)
public boolean isScanKnownConfigLocations()
public void setSwaggerUiConfig(org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig swaggerUiConfig)
public org.apache.cxf.jaxrs.swagger.ui.SwaggerUiConfig getSwaggerUiConfig()
getSwaggerUiConfig in interface org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupportpublic String findSwaggerUiRoot()
findSwaggerUiRoot in interface org.apache.cxf.jaxrs.swagger.ui.SwaggerUiSupportprotected Properties getUserProperties(Map<String,Object> userDefinedOptions)
protected void registerOpenApiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb,
org.eclipse.microprofile.openapi.models.OpenAPI openApiDefinition)
protected void registerSwaggerUiResources(org.apache.cxf.jaxrs.JAXRSServiceFactoryBean sfb,
Properties properties,
org.apache.cxf.jaxrs.provider.ServerProviderFactory factory,
org.apache.cxf.Bus bus)
Apache CXF