Class JacksonOpenApiTypeDescriber
- java.lang.Object
-
- org.apache.tapestry5.rest.jackson.internal.JacksonOpenApiTypeDescriber
-
- All Implemented Interfaces:
OpenApiTypeDescriber
public class JacksonOpenApiTypeDescriber extends java.lang.Object implements OpenApiTypeDescriber
OpenApiTypeDescriberimplementation using Java JSONSchema Generator, by default generating JSON Schema 2019-09.
-
-
Constructor Summary
Constructors Constructor Description JacksonOpenApiTypeDescriber(com.github.victools.jsonschema.generator.SchemaGenerator schemaGenerator, MappedEntityManager mappedEntityManager)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddescribe(JSONObject description, java.lang.reflect.Parameter parameter)Describes a REST event handler method parameter.voiddescribeReturnType(JSONObject description, java.lang.reflect.Method method)Describes a REST event handler method return type.voiddescribeSchema(java.lang.Class<?> entity, JSONObject schemas)Describes the schema of a mapped entity class
-
-
-
Constructor Detail
-
JacksonOpenApiTypeDescriber
public JacksonOpenApiTypeDescriber(com.github.victools.jsonschema.generator.SchemaGenerator schemaGenerator, MappedEntityManager mappedEntityManager)
-
-
Method Detail
-
describe
public void describe(JSONObject description, java.lang.reflect.Parameter parameter)
Description copied from interface:OpenApiTypeDescriberDescribes a REST event handler method parameter.- Specified by:
describein interfaceOpenApiTypeDescriber- Parameters:
description-JSONObjectcontaining the description of an event handler parameter.parameter- the event handler method parameter.
-
describeReturnType
public void describeReturnType(JSONObject description, java.lang.reflect.Method method)
Description copied from interface:OpenApiTypeDescriberDescribes a REST event handler method return type.- Specified by:
describeReturnTypein interfaceOpenApiTypeDescriber- Parameters:
description-JSONObjectcontaining the description of a path response.method- the event handler method itself.
-
describeSchema
public void describeSchema(java.lang.Class<?> entity, JSONObject schemas)
Description copied from interface:OpenApiTypeDescriberDescribes the schema of a mapped entity class- Specified by:
describeSchemain interfaceOpenApiTypeDescriber- Parameters:
entity- an entity class.schemas-JSONObjectwhere the entity description should be added.- See Also:
MappedEntityManager
-
-