Package tech.jhipster.config.apidoc.customizer

Class JHipsterSpringfoxCustomizer

java.lang.Object

tech.jhipster.config.apidoc.customizer.JHipsterSpringfoxCustomizer

All Implemented Interfaces:

org.springframework.core.Ordered, SpringfoxCustomizer

public class JHipsterSpringfoxCustomizer
extends Object
implements SpringfoxCustomizer, org.springframework.core.Ordered

A Springfox 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
JHipsterSpringfoxCustomizer(JHipsterProperties.ApiDocs properties)	Constructor for JHipsterSpringfoxCustomizer.

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

JHipsterSpringfoxCustomizer

public JHipsterSpringfoxCustomizer(JHipsterProperties.ApiDocs properties)

Constructor for JHipsterSpringfoxCustomizer.

Parameters:

properties - a JHipsterProperties.ApiDocs object.

Method Detail

customize

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

Customize the Springfox Docket.

Specified by:

customize in interface SpringfoxCustomizer

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