yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-07-26 19:10:15 +00:00
Code Issues Packages Projects Releases Wiki Activity
datahub/docs/api/datahub-apis.md
Paul Logan 4d8e1f5e78
docs(): reordering sidebar and adding homepage to apis (#7139) 
Co-authored-by: John Joyce <john@acryl.io>
2023-01-26 16:15:57 -08:00

1.7 KiB
Raw Blame History

Which DataHub API is for me?

DataHub supplys several APIs to manipulate metadata on the platform:

  • The GraphQL API is our recommended option for querying and manipulating the metadata graph.
  • The Rest.li API is a much more powerful, low level API intended only for advanced users.
  • We offer an OpenAPI schema defining the Rest.li API used by our SDKs.

GraphQL API

The GraphQL API serves as the primary public API for the platform. It can be used to fetch and update metadata programatically in the language of your choice.

Get started with the GraphQL API

Rest.li API

:::caution The Rest.li API is intended only for advanced users. If you're just getting started with DataHub, we recommend the GraphQL API :::

The Rest.li API represents the underlying persistence layer, and exposes the raw PDL models used in storage. Under the hood, it powers the GraphQL API. Aside from that, it is also used for system-specific ingestion of metadata, being used by the Metadata Ingestion Framework for pushing metadata into DataHub directly. For all intents and purposes, the Rest.li API is considered system-internal, meaning DataHub components are the only ones to consume this API directly. Get started with our Rest.li API

OpenAPI

A schema defining the Rest.li API. Get started with OpenAPI