yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-26 15:10:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: API Service Page Content Updation (#21674)

Browse Source
This commit is contained in:
Rounak Dhillon 2025-06-12 11:59:29 +05:30 committed by GitHub
parent 18f9f2cdb6
commit e3495a0770
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 66 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
openmetadata-docs/content/v1.6.x/connectors/api/index.md
View File

@ -5,9 +5,31 @@ slug: /connectors/api
# API Services
## Overview
The OpenMetadata API service facilitates metadata ingestion from RESTful APIs that expose OpenAPI (Swagger) specifications. This connector is particularly useful for integrating custom services or third-party tools that are not natively supported by OpenMetadata.
This is the supported list of connectors for API Services:
{% partial file="/v1.6/connectors/api/connectors-list.md" /%}
## Supported Features
- Metadata Ingestion: Extracts metadata from services exposing OpenAPI JSON schemas.
- Custom Integration: Allows integration with bespoke systems through standardized API definitions.
- Flexible Deployment: Supports both UI-based and CLI-based ingestion workflows.
## Use Cases
- Custom Application Integration: Ingest metadata from proprietary applications exposing OpenAPI specifications.
- Third-Party Tools: Integrate with external tools and platforms that provide RESTful APIs.
- Extended Metadata Management: Enhance metadata coverage by incorporating services beyond the default connectors.
## Best Practices
- Schema Validation: Ensure the OpenAPI JSON schema is valid and accessible.
- Authentication Management: Securely store and manage authentication tokens required for API access.
- Regular Updates: Periodically update the OpenAPI JSON schema URL if the API definitions change.
If you have a request for a new connector, don't hesitate to reach out in [Slack](https://slack.open-metadata.org/) or
open a [feature request](https://github.com/open-metadata/OpenMetadata/issues/new/choose) in our GitHub repo.

22
openmetadata-docs/content/v1.7.x/connectors/api/index.md
View File

@ -5,9 +5,31 @@ slug: /connectors/api
# API Services
## Overview
The OpenMetadata API service facilitates metadata ingestion from RESTful APIs that expose OpenAPI (Swagger) specifications. This connector is particularly useful for integrating custom services or third-party tools that are not natively supported by OpenMetadata.
This is the supported list of connectors for API Services:
{% partial file="/v1.7/connectors/api/connectors-list.md" /%}
## Supported Features
- Metadata Ingestion: Extracts metadata from services exposing OpenAPI JSON schemas.
- Custom Integration: Allows integration with bespoke systems through standardized API definitions.
- Flexible Deployment: Supports both UI-based and CLI-based ingestion workflows.
## Use Cases
- Custom Application Integration: Ingest metadata from proprietary applications exposing OpenAPI specifications.
- Third-Party Tools: Integrate with external tools and platforms that provide RESTful APIs.
- Extended Metadata Management: Enhance metadata coverage by incorporating services beyond the default connectors.
## Best Practices
- Schema Validation: Ensure the OpenAPI JSON schema is valid and accessible.
- Authentication Management: Securely store and manage authentication tokens required for API access.
- Regular Updates: Periodically update the OpenAPI JSON schema URL if the API definitions change.
If you have a request for a new connector, don't hesitate to reach out in [Slack](https://slack.open-metadata.org/) or
open a [feature request](https://github.com/open-metadata/OpenMetadata/issues/new/choose) in our GitHub repo.

22
openmetadata-docs/content/v1.8.x-SNAPSHOT/connectors/api/index.md
View File

@ -5,9 +5,31 @@ slug: /connectors/api
# API Services
## Overview
The OpenMetadata API service facilitates metadata ingestion from RESTful APIs that expose OpenAPI (Swagger) specifications. This connector is particularly useful for integrating custom services or third-party tools that are not natively supported by OpenMetadata.
This is the supported list of connectors for API Services:
{% partial file="/v1.8/connectors/api/connectors-list.md" /%}
## Supported Features
- Metadata Ingestion: Extracts metadata from services exposing OpenAPI JSON schemas.
- Custom Integration: Allows integration with bespoke systems through standardized API definitions.
- Flexible Deployment: Supports both UI-based and CLI-based ingestion workflows.
## Use Cases
- Custom Application Integration: Ingest metadata from proprietary applications exposing OpenAPI specifications.
- Third-Party Tools: Integrate with external tools and platforms that provide RESTful APIs.
- Extended Metadata Management: Enhance metadata coverage by incorporating services beyond the default connectors.
## Best Practices
- Schema Validation: Ensure the OpenAPI JSON schema is valid and accessible.
- Authentication Management: Securely store and manage authentication tokens required for API access.
- Regular Updates: Periodically update the OpenAPI JSON schema URL if the API definitions change.
If you have a request for a new connector, don't hesitate to reach out in [Slack](https://slack.open-metadata.org/) or
open a [feature request](https://github.com/open-metadata/OpenMetadata/issues/new/choose) in our GitHub repo.