Package org.springdoc.core.converters

Class PageOpenAPIConverter

java.lang.Object
org.springdoc.core.converters.PageOpenAPIConverter
All Implemented Interfaces:
io.swagger.v3.core.converter.ModelConverter
public class PageOpenAPIConverter extends Object implements io.swagger.v3.core.converter.ModelConverter
The Spring Data Page type model converter.
Author:
Claudio Nave

  • Constructor Summary

    Constructors
    Constructor
    Description
    PageOpenAPIConverter(boolean replacePageWithPagedModel, ObjectMapperProvider springDocObjectMapper)
    Instantiates a new Page open api converter.

  • Method Summary

    Modifier and Type
    Method
    Description
    io.swagger.v3.oas.models.media.Schema
    resolve(io.swagger.v3.core.converter.AnnotatedType type, io.swagger.v3.core.converter.ModelConverterContext context, Iterator<io.swagger.v3.core.converter.ModelConverter> chain)
    Resolve schema.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface io.swagger.v3.core.converter.ModelConverter

    isOpenapi31

  • Constructor Details

    • PageOpenAPIConverter

      public PageOpenAPIConverter(boolean replacePageWithPagedModel, ObjectMapperProvider springDocObjectMapper)
      Instantiates a new Page open api converter.
      Parameters:
      replacePageWithPagedModel - flag to replace Page with PagedModel or not
      springDocObjectMapper - the spring doc object mapper

  • Method Details

    • resolve

      public io.swagger.v3.oas.models.media.Schema resolve(io.swagger.v3.core.converter.AnnotatedType type, io.swagger.v3.core.converter.ModelConverterContext context, Iterator<io.swagger.v3.core.converter.ModelConverter> chain)
      Resolve schema.
      Specified by:
      resolve in interface io.swagger.v3.core.converter.ModelConverter
      Parameters:
      type - the type
      context - the context
      chain - the chain
      Returns:
      the schema