Select supported API specifications

To make API definitions discoverable and interactive within the Red Hat Developer Hub portal, use a supported specification format. The right format allows the platform to render documentation and give testing interfaces for other developers.

Supported API formats

  • OpenAPI: Use this standard format (formerly Swagger) for defining RESTful APIs. RHDH renders these specifications into interactive documentation, allowing users to run requests directly from the Definition tab.
  • AsyncAPI: Use this format for event-driven architectures and message-based services. This ensures that producers and consumers can visualize message schemas and broker details within the Software Catalog.
  • GraphQL: Use this format to define GraphQL schemas. This allows developers to explore your data graph, including queries, mutations, and types, from a centralized location.
Note

Support for specific formats, such as AsyncAPI or GraphQL, depends on your organization’s instance configuration and enabled plugins. If a specification does not render, verify your catalog-info.yaml metadata or contact your platform administrator.