USER MANUALS

OpenAPI Specification

The OpenAPI Specification (OAS) provides a consistent means to carry information through each stage of the API lifecycle. It is a specification language for HTTP APIs that defines structure and syntax in a way that is not wedded to the programming language the API is created in. API specifications are typically written in YAML or JSON, allowing for easy sharing and consumption of the specification.

The Denodo OData4 service supports OpenAPI 3.0 version. Note that, as the service has read-only capabilites, the OAS will only describe the GET methods of each virtual database.

OpenAPI Documents

An OpenAPI document can be represented by a file in JSON or YAML format, so they will be accesible as openapi.json and openapi.yaml files from the following endpoints:

/denodo-odata.svc/<database name>/openapi.json
/denodo-odata.svc/<database name>/openapi.yaml

Authentication

As well as the rest of the Denodo OData4 Service resources, the OpenAPI documents can be accessed by the following authentication methods:

  • Basic Authentication

  • OAuth 2.0

  • Kerberos

Swagger UI

Denodo distributes an instance of Swagger UI that can be used to access Denodo OData4 Service OpenAPI specification:

https://<denodo_server>:9443/swagger-ui?url=https://<denodo_server>:9443/denodo-odata4-service/denodo-odata.svc/<denodo-database>/openapi.json
http://<denodo_server>:9090/swagger-ui?url=http://<denodo_server>:9090/denodo-odata4-service/denodo-odata.svc/<denodo-database>/openapi.json

For example:

Swagger UI example

See OpenAPI / Swagger section of the user manual for more information about the distributed Swagger UI instance.

Important

SwaggerUI supports displaying remote OpenAPI definitions through the ?url parameter. This functionality is enabled by default and needs to be enabled in order to work with the Denodo OData4 Service OpenAPI documents.

Add feedback