Class JacksonOpenApiTypeDescriber
java.lang.Object
org.apache.tapestry5.rest.jackson.internal.JacksonOpenApiTypeDescriber
- All Implemented Interfaces:
OpenApiTypeDescriber
OpenApiTypeDescriber implementation using
Java JSONSchema Generator,
by default generating JSON Schema 2019-09.-
Constructor Summary
ConstructorsConstructorDescriptionJacksonOpenApiTypeDescriber(com.github.victools.jsonschema.generator.SchemaGenerator schemaGenerator, MappedEntityManager mappedEntityManager) -
Method Summary
Modifier and TypeMethodDescriptionvoiddescribe(JSONObject description, Parameter parameter) Describes a REST event handler method parameter.voiddescribeReturnType(JSONObject description, Method method) Describes a REST event handler method return type.voiddescribeSchema(Class<?> entity, JSONObject schemas) Describes the schema of a mapped entity class
-
Constructor Details
-
JacksonOpenApiTypeDescriber
public JacksonOpenApiTypeDescriber(com.github.victools.jsonschema.generator.SchemaGenerator schemaGenerator, MappedEntityManager mappedEntityManager)
-
-
Method Details
-
describe
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
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
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:
-