Introduction to the REST API

The Platformatic DB OpenAPI plugin automatically starts a REST API server (powered by Fastify) that provides CRUD (Create, Read, Update, Delete) functionality for each entity.

Configuration

In the config file, under the "db" section, the OpenAPI server is enabled by default. Although you can disable it setting the property openapi to false.

Example

{
  ...
  "db": {
    "openapi": false
  }
}

As Platformatic DB uses fastify-swagger under the hood, the "openapi" property can be an object that follows the OpenAPI Specification Object format.

This allows you to extend the output of the Swagger UI documentation.