org.springdoc.hateoas.converters

Class OpenApiHateoasLinksCustomiser

java.lang.Object

io.swagger.v3.core.filter.SpecFilter

org.springdoc.hateoas.converters.OpenApiHateoasLinksCustomiser

All Implemented Interfaces:

GlobalOpenApiCustomizer, OpenApiCustomiser

public class OpenApiHateoasLinksCustomiser
extends io.swagger.v3.core.filter.SpecFilter
implements GlobalOpenApiCustomizer

The type Open api hateoas links customiser.

Author:

bnasslahsen

Constructor Summary

Constructors

Constructor and Description
OpenApiHateoasLinksCustomiser(SpringDocConfigProperties springDocConfigProperties) Instantiates a new Open api hateoas links customiser.

Method Summary

Modifier and Type	Method and Description
void	customise(io.swagger.v3.oas.models.OpenAPI openApi)

Methods inherited from class io.swagger.v3.core.filter.SpecFilter

filter, filterComponentsSchema, filterOpenAPI, filterOperation, filterParameter, filterPathItem, filterRequestBody, filterResponse, locateReferencedDefinitions, removeBrokenReferenceDefinitions, resolveAllNestedRefs

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenApiHateoasLinksCustomiser

public OpenApiHateoasLinksCustomiser(SpringDocConfigProperties springDocConfigProperties)

Instantiates a new Open api hateoas links customiser.

Parameters:

springDocConfigProperties - the spring doc config properties

Method Detail

customise

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

Specified by:

customise in interface OpenApiCustomiser