Package org.springdoc.core.customizers

Class OpenApiHateoasLinksCustomizer

java.lang.Object
io.swagger.v3.core.filter.SpecFilter
org.springdoc.core.customizers.OpenApiHateoasLinksCustomizer
All Implemented Interfaces:
GlobalOpenApiCustomizer, OpenApiCustomizer
public class OpenApiHateoasLinksCustomizer extends io.swagger.v3.core.filter.SpecFilter implements GlobalOpenApiCustomizer
The type Open api hateoas links customiser.
Author:
bnasslahsen

  • Constructor Summary

    Constructors
    Constructor
    Description
    OpenApiHateoasLinksCustomizer(SpringDocConfigProperties springDocConfigProperties)
    Instantiates a new Open api hateoas links customiser.

  • Method Summary

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

    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 Details

    • OpenApiHateoasLinksCustomizer

      public OpenApiHateoasLinksCustomizer(SpringDocConfigProperties springDocConfigProperties)
      Instantiates a new Open api hateoas links customiser.
      Parameters:
      springDocConfigProperties - the spring doc config properties

  • Method Details

    • customise

      public void customise(io.swagger.v3.oas.models.OpenAPI openApi)
      Description copied from interface: OpenApiCustomizer
      Customise.
      Specified by:
      customise in interface OpenApiCustomizer
      Parameters:
      openApi - the open api