Package io.github.jhipster.config.apidoc.customizer

Class JHipsterSwaggerCustomizer

java.lang.Object

io.github.jhipster.config.apidoc.customizer.JHipsterSwaggerCustomizer

All Implemented Interfaces:

SwaggerCustomizer, org.springframework.core.Ordered

public class JHipsterSwaggerCustomizer
extends Object
implements SwaggerCustomizer, org.springframework.core.Ordered

A swagger customizer to setup Docket with JHipster settings.

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_ORDER	The default order for the customizer.

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
JHipsterSwaggerCustomizer(JHipsterProperties.Swagger properties)	Constructor for JHipsterSwaggerCustomizer.

Method Summary

Modifier and Type	Method	Description
void	customize(springfox.documentation.spring.web.plugins.Docket docket)	Customize the Springfox Docket.
int	getOrder()
void	setOrder(int order)	Setter for the field order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_ORDER

public static final int DEFAULT_ORDER

The default order for the customizer.

See Also:

Constant Field Values

Constructor Detail

JHipsterSwaggerCustomizer

public JHipsterSwaggerCustomizer(JHipsterProperties.Swagger properties)

Constructor for JHipsterSwaggerCustomizer.

Parameters:

properties - a JHipsterProperties.Swagger object.

Method Detail

customize

public void customize(springfox.documentation.spring.web.plugins.Docket docket)

Customize the Springfox Docket.

Specified by:

customize in interface SwaggerCustomizer

Parameters:

docket - the Docket to customize

setOrder

public void setOrder(int order)

Setter for the field order.

Parameters:

order - a int.

getOrder

public int getOrder()

Specified by:

getOrder in interface org.springframework.core.Ordered