Back to Graphql Engine

Export OpenAPI Specification

docs/docs/restified/export-oas.mdx

2.50.1908 B
Original Source

import SampleAppBlock from '@site/src/components/SampleAppBlock'; import Thumbnail from '../../src/components/Thumbnail'; import GraphiQLIDE from '@site/src/components/GraphiQLIDE'; import VersionedLink from '@site/src/components/VersionedLink';

Export OpenAPI Specification

The OpenAPI Specification (OAS) is widely used in REST API development to provide a standardized format for documenting RESTful APIs.

You can download the OpenAPI 3 specification (OAS 3.0) as a JSON file for all the RESTified GraphQL Endpoints for admin roles by clicking in the Export OpenAPI Spec button from the REST endpoints tab from the API section.

<Thumbnail src="/img/restified/restified-OAS-spec.png" alt="Create RESTified Endpoint" width="1000px" />

You can also <VersionedLink to="/api-reference/restified/#openapi-3-specification">utilize the API</VersionedLink> to download the OpenAPI 3 specification