OpenAPI Translator

The OpenAPI translator, known by the type name "openapi" exposes OpenAPI data sources via realational concepts and uses the Teiid WS resource adapter for making web service calls.

Note

What is OpenAPI - [OpenAPI is a simple yet powerful representation of your RESTful API. With the largest ecosystem of API tooling on the planet, thousands of developers are supporting OpenAPI in almost every modern programming language and deployment environment. With a OpenAPI-enabled API, you get interactive documentation, client SDK generation and discoverability.

This translator is compatible with OpenAPI/Swagger v2 and OpenAPI v3.

Usage

Usage of a OpenAPI source is similar any other translator in Teiid. The metadata import is supported through the translator. the metadata is imported from source system’s metadata file and then exposed as stored procedures in Teiid. The source system can be queried by executing these stored procedures in Teiid system.

Note

Parameter order is guaranteed by the swagger libraries. However it is recommended that you call procedures using named, rather than positional parameters, if you rely upon the native import.

JCA Resource Adapter

Native Queries - Native or direct query execution is not supported through OpenAPI translator. However, user can use Web Services Translator’s invokehttp method directly to issue a Rest based call and parse results using SQLXML.

Limitations

"application/xml" mime type in both "Accept" and "Content-Type" is currently not supported

File, Map properties are currently not supported, thus any multi-part payloads are not supported

Security metadata is currently not supported

Custom properties that start with "x-" are not supported.

Schema with "allof", "multipleof", "items" from JSON schema are not supported