com.holonplatform.jaxrs.swagger.annotations

Annotation Type ApiConfiguration

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
public @interface ApiConfiguration

Annotation which can be used on a API configuration class to setup the API listing endpoint.

Since:

5.2.0

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	contextId Get the API context id.
ApiEndpointType	endpointType Get the API listing endpoint type.
String	path Get the API listing endpoint path.
JaxrsScannerType	scannerType Get the scanner type to use to detect API resource classes.

Element Detail

contextId

public abstract String contextId

Get the API context id.

Returns:

the API context id

Default:

"openapi.context.id.default"

path

public abstract String path

Get the API listing endpoint path.

Default is ApiDefaults.DEFAULT_API_ENDPOINT_PATH.

Returns:

the API listing endpoint path

Default:

"/api-docs"

endpointType

public abstract ApiEndpointType endpointType

Get the API listing endpoint type.

Default is ApiEndpointType.QUERY_PARAMETER.

Returns:

the API listing endpoint type

Default:

com.holonplatform.jaxrs.swagger.ApiEndpointType.QUERY_PARAMETER

scannerType

public abstract JaxrsScannerType scannerType

Get the scanner type to use to detect API resource classes.

Default is JaxrsScannerType.DEFAULT.

Returns:

the API resource classes scanner type

Default:

com.holonplatform.jaxrs.swagger.JaxrsScannerType.DEFAULT