io.syndesis.server.api.generator.openapi

Interface DataShapeGenerator<T extends io.apicurio.datamodels.openapi.models.OasDocument,O extends io.apicurio.datamodels.openapi.models.OasOperation>

Type Parameters:

T - the OpenAPI document type representing version 2.x or 3.x.

O - the OpenAPI operation type.

All Known Implementing Classes:

UnifiedJsonDataShapeSupport, UnifiedXmlDataShapeSupport

public interface DataShapeGenerator<T extends io.apicurio.datamodels.openapi.models.OasDocument,O extends io.apicurio.datamodels.openapi.models.OasOperation>

Data shape generator creates request and response data shapes from OpenAPI operations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DataShapeGenerator.NameAndSchema Combination of schema and name for request body.

Field Summary

Fields

Modifier and Type	Field and Description
static String	APPLICATION_JSON
static String	APPLICATION_XML
static DataShape	DATA_SHAPE_NONE

Method Summary

Modifier and Type	Method and Description
DataShape	createShapeFromRequest(com.fasterxml.jackson.databind.node.ObjectNode json, T openApiDoc, O operation)
DataShape	createShapeFromResponse(com.fasterxml.jackson.databind.node.ObjectNode json, T openApiDoc, O operation)
default Optional<DataShapeGenerator.NameAndSchema>	findBodySchema(T openApiDoc, O operation) Find schema that is specified to define the body if any.
default <R extends io.apicurio.datamodels.openapi.models.OasResponse> Optional<R>	findResponse(T openApiDoc, O operation, Predicate<R> hasSchema, Class<R> responseType) Find response for given operation.
default List<io.apicurio.datamodels.openapi.models.OasResponse>	resolveResponses(T openApiDoc, List<io.apicurio.datamodels.openapi.models.OasResponse> operationResponses) Method resolves response references in given list of operation responses.

Field Detail

APPLICATION_JSON

static final String APPLICATION_JSON

See Also:

Constant Field Values

APPLICATION_XML

static final String APPLICATION_XML

See Also:

Constant Field Values

DATA_SHAPE_NONE

static final DataShape DATA_SHAPE_NONE

Method Detail

createShapeFromRequest

DataShape createShapeFromRequest(com.fasterxml.jackson.databind.node.ObjectNode json,
                                 T openApiDoc,
                                 O operation)

createShapeFromResponse

DataShape createShapeFromResponse(com.fasterxml.jackson.databind.node.ObjectNode json,
                                  T openApiDoc,
                                  O operation)

findBodySchema

default Optional<DataShapeGenerator.NameAndSchema> findBodySchema(T openApiDoc,
                                                                  O operation)

Find schema that is specified to define the body if any.

Parameters:

openApiDoc - the OpenAPI document.

operation - maybe holding a body schema.

Returns:

the body schema.

findResponse

default <R extends io.apicurio.datamodels.openapi.models.OasResponse> Optional<R> findResponse(T openApiDoc,
                                                                                               O operation,
                                                                                               Predicate<R> hasSchema,
                                                                                               Class<R> responseType)

Find response for given operation. Favors positive responses with status code 2xx and a body schema. Only in case no positive response is present pick the first response with a schema present.

Type Parameters:

R - type of the response to return.

Parameters:

openApiDoc - the OpenAPI document.

operation - the operation holding some response definitions.

hasSchema - predicate checks that response has a schema defined.

responseType - the target response type.

Returns:

a response on the given operation that has a schema or empty.

resolveResponses

default List<io.apicurio.datamodels.openapi.models.OasResponse> resolveResponses(T openApiDoc,
                                                                                 List<io.apicurio.datamodels.openapi.models.OasResponse> operationResponses)

Method resolves response references in given list of operation responses. Each response can reference a reusable response definition on the OpenAPI document. When such a reference is found in the list of responses resolve the reference to the definition object. So the resulting list of responses does only container real response objects and no references anymore.

Parameters:

openApiDoc - the OpenAPI document.

operationResponses - the responses for an operation.

Returns:

list of real response objects where references to reusable response definitions are resolved.