Class HALModelConverter

java.lang.Object
io.swagger.v3.core.jackson.AbstractModelConverter
io.openapitools.hal.HALModelConverter
All Implemented Interfaces:
io.swagger.v3.core.converter.ModelConverter

public class HALModelConverter
extends io.swagger.v3.core.jackson.AbstractModelConverter
Converter to handle HAL annotated classes. It ensures embedded resources and links are arranged into an "_embedded" and "_links" object respectively.
  • Field Summary

    Fields inherited from class io.swagger.v3.core.jackson.AbstractModelConverter

    _intr, _mapper, _resolvedTypeNames, _typeNameResolver
  • Constructor Summary

    Constructors
    Constructor Description
    HALModelConverter()  
    HALModelConverter​(com.fasterxml.jackson.databind.ObjectMapper mapper)  
  • Method Summary

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

    Methods inherited from class io.swagger.v3.core.jackson.AbstractModelConverter

    _findTypeName, _isSetType, _subTypeName, _typeName, _typeName, _typeQName

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

    • HALModelConverter

      public HALModelConverter()
    • HALModelConverter

      public HALModelConverter​(com.fasterxml.jackson.databind.ObjectMapper mapper)
  • Method Details

    • resolve

      public io.swagger.v3.oas.models.media.Schema resolve​(io.swagger.v3.core.converter.AnnotatedType annotatedType, io.swagger.v3.core.converter.ModelConverterContext context, Iterator<io.swagger.v3.core.converter.ModelConverter> chain)
      Specified by:
      resolve in interface io.swagger.v3.core.converter.ModelConverter
      Overrides:
      resolve in class io.swagger.v3.core.jackson.AbstractModelConverter