Package tech.jhipster.config.apidoc.customizer

Class JHipsterOpenApiCustomizer

java.lang.Object

tech.jhipster.config.apidoc.customizer.JHipsterOpenApiCustomizer

All Implemented Interfaces:

org.springdoc.core.customizers.OpenApiCustomiser, org.springframework.core.Ordered

public class JHipsterOpenApiCustomizer
extends Object
implements org.springdoc.core.customizers.OpenApiCustomiser, org.springframework.core.Ordered

A OpenApi customizer to setup OpenAPI 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
JHipsterOpenApiCustomizer(JHipsterProperties.ApiDocs properties)	Constructor for JHipsterOpenApiCustomizer.

Method Summary

Modifier and Type	Method	Description
void	customise(io.swagger.v3.oas.models.OpenAPI openAPI)
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

JHipsterOpenApiCustomizer

public JHipsterOpenApiCustomizer(JHipsterProperties.ApiDocs properties)

Constructor for JHipsterOpenApiCustomizer.

Parameters:

properties - a JHipsterProperties.ApiDocs object.

Method Detail

customise

public void customise(io.swagger.v3.oas.models.OpenAPI openAPI)

Specified by:

customise in interface org.springdoc.core.customizers.OpenApiCustomiser

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