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 TypeMethodDescriptionvoid
describe
(JSONObject description, Parameter parameter) Describes a REST event handler method parameter.void
describeReturnType
(JSONObject description, Method method) Describes a REST event handler method return type.void
describeSchema
(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:OpenApiTypeDescriber
Describes a REST event handler method parameter.- Specified by:
describe
in interfaceOpenApiTypeDescriber
- Parameters:
description
-JSONObject
containing the description of an event handler parameter.parameter
- the event handler method parameter.
-
describeReturnType
Description copied from interface:OpenApiTypeDescriber
Describes a REST event handler method return type.- Specified by:
describeReturnType
in interfaceOpenApiTypeDescriber
- Parameters:
description
-JSONObject
containing the description of a path response.method
- the event handler method itself.
-
describeSchema
Description copied from interface:OpenApiTypeDescriber
Describes the schema of a mapped entity class- Specified by:
describeSchema
in interfaceOpenApiTypeDescriber
- Parameters:
entity
- an entity class.schemas
-JSONObject
where the entity description should be added.- See Also:
-