Interface ResponseSchemaGenerator


  • public interface ResponseSchemaGenerator
    Interface for generating json response schemas for a given class.
    • Field Detail

      • LOGGER

        static final org.slf4j.Logger LOGGER
    • Method Detail

      • generateSchema

        String generateSchema​(Class<?> clazz)
        Generate a json schema for the given class.
        Parameters:
        clazz - The class to generate a schema for.
        Returns:
        The json schema.
      • jacksonGenerator

        static ResponseSchemaGenerator jacksonGenerator()
        Load a response schema generator based on the Jackson library, requires that com.github.victools:jsonschema-generator has been added to the class path.
        Returns:
        The response schema generator.
      • loadGenerator

        static ResponseSchemaGenerator loadGenerator​(String className)
        Load a response schema generator based on the given class name. The class must implement the ResponseSchemaGenerator interface.
        Parameters:
        className - The class name of the generator.
        Returns:
        The response schema generator.