Run the OpenAPI/REST Connector Externally

Learn how to configure OpenMetadata REST API connectors using YAML. Complete documentation with examples, parameters, and best practices for seamless integration.

In this section, we provide guides and references to use the OpenAPI/REST connector. Configure and schedule REST metadata workflows from the OpenMetadata UI:

• Requirements
• Metadata Ingestion

Requirements

Python Requirements

We have support for Python versions 3.9-3.11

Generate OpenAPI Schema URL

• Generate OpenAPI schema URL for your serviceOpenAPI spec

Metadata Ingestion

1. Define the YAML Config

This is a sample config for OpenAPI:

2. Run with the CLI

First, we will need to save the YAML file. Afterward, and with all requirements installed, we can run:

metadata ingest -c <path-to-yaml>

Note that from connector to connector, this recipe will always be the same. By updating the YAML configuration, you will be able to extract metadata from different sources.