org.spincast.plugins.swagger.ui.config

Interface SpincastSwaggerUiConfig

All Known Implementing Classes:

SpincastSwaggerUiConfigDefault

public interface SpincastSwaggerUiConfig

Method Summary

Modifier and Type	Method and Description
String	getOpenApiSpecificationsUrl() The absolute URL or relative path to the Open API specifications file.
String	getSwaggerUiPath() The URL path the Swagger UI will be served on.
boolean	showTopBar() If true, the top bar of the UI will be shown.

Method Detail

getSwaggerUiPath

String getSwaggerUiPath()

The URL path the Swagger UI will be served on.

Defaults to "/swagger-ui"

getOpenApiSpecificationsUrl

String getOpenApiSpecificationsUrl()

The absolute URL or relative path to the Open API specifications file.

Defaults to "https://petstore.swagger.io/v2/swagger.json"

showTopBar

boolean showTopBar()

If true, the top bar of the UI will be shown.

Defaults to false.