org.apache.cxf.jaxrs.swagger.ui

Interface SwaggerUiSupport

All Known Implementing Classes:

OpenApiFeature, OpenApiFeature, OpenApiFeature.Portable, OpenApiFeature.Portable, Swagger2Feature, Swagger2Feature.Portable

public interface SwaggerUiSupport

Generic trait to support Swagger UI integration for Swagger 1.5.x and OpenAPI v3.x (Swagger 2.x) integrations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SwaggerUiSupport.Registration Holds the resources and/or providers which are required for Swagger UI integration to be plugged in.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SUPPORT_UI_PROPERTY

Method Summary

Modifier and Type	Method and Description
default boolean	checkSupportSwaggerUiProp(Properties props) Checks the Swagger properties to determine if Swagger UI support is available or not.
String	findSwaggerUiRoot() Detects the Swagger UI in root with respect to properties and configuration provided.
default SwaggerUiSupport.Registration	getSwaggerUi(Bus bus, Properties swaggerProps, boolean runAsFilter) Detects the presence of Swagger UI in classpath with respect to properties and configuration provided.
SwaggerUiConfig	getSwaggerUiConfig() Returns Swagger UI configuration parameters.
Map<String,String>	getSwaggerUiMediaTypes() Returns media types supported by Swagger UI
Boolean	isSupportSwaggerUi() Checks if Swagger UI support is available or not.

Field Detail

SUPPORT_UI_PROPERTY

static final String SUPPORT_UI_PROPERTY

See Also:

Constant Field Values

Method Detail

getSwaggerUi

default SwaggerUiSupport.Registration getSwaggerUi(Bus bus,
                                                   Properties swaggerProps,
                                                   boolean runAsFilter)

Detects the presence of Swagger UI in classpath with respect to properties and configuration provided.

Parameters:

bus - bus instance

swaggerProps - Swagger properties (usually externalized)

runAsFilter - "true" if Swagger integration is run as a filter, "false" otherwise.

Returns:

the Swagger UI registration

checkSupportSwaggerUiProp

default boolean checkSupportSwaggerUiProp(Properties props)

Checks the Swagger properties to determine if Swagger UI support is available or not.

Parameters:

props - Swagger properties (usually externalized)

Returns:

isSupportSwaggerUi

Boolean isSupportSwaggerUi()

Checks if Swagger UI support is available or not.

Returns:

"true" if Swagger UI support is available, "false" otherwise

findSwaggerUiRoot

String findSwaggerUiRoot()

Detects the Swagger UI in root with respect to properties and configuration provided.

Returns:

Swagger UI in root or "null" if not available

getSwaggerUiMediaTypes

Map<String,String> getSwaggerUiMediaTypes()

Returns media types supported by Swagger UI

Returns:

media types supported by Swagger UI

getSwaggerUiConfig

SwaggerUiConfig getSwaggerUiConfig()

Returns Swagger UI configuration parameters.

Returns:

Swagger UI configuration parameters or "null" if not available