public.javadoc.org.spincast.plugins.swagger.ui.config.SpincastSwaggerUiConfigDefault.html Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of spincast-website Show documentation

Source code for the https://www.spincast.org website.

There is a newer version: 2.2.0







SpincastSwaggerUiConfigDefault (org.spincast:spincast-framework 1.7.1 API)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








org.spincast.plugins.swagger.ui.config
Class SpincastSwaggerUiConfigDefault



java.lang.Object


org.spincast.plugins.swagger.ui.config.SpincastSwaggerUiConfigDefault







All Implemented Interfaces:
SpincastSwaggerUiConfig




public class SpincastSwaggerUiConfigDefault
extends Object
implements SpincastSwaggerUiConfig











Constructor Summary

Constructors 

Constructor and Description


SpincastSwaggerUiConfigDefault() 









Method Summary

All Methods Instance Methods Concrete Methods 

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.







Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait














Constructor Detail





SpincastSwaggerUiConfigDefault
public SpincastSwaggerUiConfigDefault()









Method Detail





getSwaggerUiPath
public String getSwaggerUiPath()
Description copied from interface: SpincastSwaggerUiConfig
The URL path the Swagger UI will be served on.
 
 Defaults to "/swagger-ui"

Specified by:
getSwaggerUiPath in interface SpincastSwaggerUiConfig








getOpenApiSpecificationsUrl
public String getOpenApiSpecificationsUrl()
Description copied from interface: SpincastSwaggerUiConfig
The absolute URL or relative path to the Open API
 specifications file.
 
 Defaults to "https://petstore.swagger.io/v2/swagger.json"

Specified by:
getOpenApiSpecificationsUrl in interface SpincastSwaggerUiConfig








showTopBar
public boolean showTopBar()
Description copied from interface: SpincastSwaggerUiConfig
If true, the top bar of the UI
 will be shown.
 
 Defaults to false.

Specified by:
showTopBar in interface SpincastSwaggerUiConfig














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help

 Spincast Framework Javadoc



Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2019. All rights reserved.

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.