BackendOpenApi #

Available since 2.17.0

The BackendOpenApi class handles OpenAPI definition.

It is accessible from the Backend.openApi property.

See the OpenAPI guide.

definition #

TypeDescriptionget / set
Partial<OpenApiDefinition>
OpenAPI definitionget / set

Example: Default content of the OpenAPI definition

app.openApi.definition

/*
{
  openapi: '3.1.0',
  info: {
    title: `${application.name} API`,
    description: `${application.name} HTTP API definition`,
    contact: {
      name: 'Kuzzle team',
      url: 'https://kuzzle.io',
      email: 'support@kuzzle.io',
    },
    license: {
      name: 'Apache 2',
      url: 'http://opensource.org/licenses/apache2.0',
    },
    version: application.version,
  },
  externalDocs: {
    description: 'Kuzzle API Documentation',
    url: 'https://docs.kuzzle.io/core/2/api/',
  },
  tags: [],
  schemes: ['https', 'http'],
  paths: {},
}
*/