Package org.apache.cxf.jaxrs.common.openapi

Interface SwaggerProperties

public interface SwaggerProperties

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CONTACT_PROPERTY
static final String	DEFAULT_LICENSE_URL
static final String	DEFAULT_LICENSE_VALUE
static final String	DEFAULT_PROPS_LOCATION
static final String	DESCRIPTION_PROPERTY
static final String	FILTER_CLASS_PROPERTY
static final String	LICENSE_PROPERTY
static final String	LICENSE_URL_PROPERTY
static final String	PRETTY_PRINT_PROPERTY
static final String	RESOURCE_PACKAGE_PROPERTY
static final String	TERMS_URL_PROPERTY
static final String	TITLE_PROPERTY
static final String	VERSION_PROPERTY

Method Summary

Modifier and Type	Method	Description
default Properties	getSwaggerProperties(String location, org.apache.cxf.Bus bus)	Read the Swagger-specific properties from the property file (to seamlessly support the migration from older Swagger features).

Field Details

DEFAULT_PROPS_LOCATION

static final String DEFAULT_PROPS_LOCATION

See Also:

• Constant Field Values

DEFAULT_LICENSE_VALUE

static final String DEFAULT_LICENSE_VALUE

See Also:

• Constant Field Values

DEFAULT_LICENSE_URL

static final String DEFAULT_LICENSE_URL

See Also:

• Constant Field Values

RESOURCE_PACKAGE_PROPERTY

static final String RESOURCE_PACKAGE_PROPERTY

See Also:

• Constant Field Values

TITLE_PROPERTY

static final String TITLE_PROPERTY

See Also:

• Constant Field Values

VERSION_PROPERTY

static final String VERSION_PROPERTY

See Also:

• Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

See Also:

• Constant Field Values

CONTACT_PROPERTY

static final String CONTACT_PROPERTY

See Also:

• Constant Field Values

LICENSE_PROPERTY

static final String LICENSE_PROPERTY

See Also:

• Constant Field Values

LICENSE_URL_PROPERTY

static final String LICENSE_URL_PROPERTY

See Also:

• Constant Field Values

TERMS_URL_PROPERTY

static final String TERMS_URL_PROPERTY

See Also:

• Constant Field Values

PRETTY_PRINT_PROPERTY

static final String PRETTY_PRINT_PROPERTY

See Also:

• Constant Field Values

FILTER_CLASS_PROPERTY

static final String FILTER_CLASS_PROPERTY

See Also:

• Constant Field Values

Method Details

getSwaggerProperties

default Properties getSwaggerProperties(String location,
 org.apache.cxf.Bus bus)

Read the Swagger-specific properties from the property file (to seamlessly support the migration from older Swagger features).

Parameters:

location - property file location

bus - bus instance

Returns:

the properties if available