{"componentChunkName":"component---src-templates-simple-markdown-js","path":"/developer-portal/oas-definitions/","matchPath":"","result":{"data":{"markdownRemark":{"html":"

OpenAPI spec definitions

\n

The developer portal may contain multiple API definitions.

\n

Define that in the siteConfig.yaml file.

\n
\n
\n
Copy
\n
Copied
\n
\n 
oasDefinitions:\n  petstore: ./openapi/petstore.yaml
\n
\n

Notice that the petstore is pointing to an API definition on the local filesystem.

\n

For a great docs-like-code experience, we recommend pointing to our API registry links.\nThat will cause any update to those API definitions to trigger an update to your developer portal.

\n

A private definition can be accessed locally by using the OpenAPI CLI login command.

\n

This is outside of the scope of this training exercise.

\n

Add more OpenAPI definitions

\n

Follow the example here, but utilize your own API definitions and rename them accordingly.\nIf your API definitions are accessible by URL, you may use those.\nOr else, add it to the local file system.

\n
\n
\n
Copy
\n
Copied
\n
\n 
oasDefinitions:\n  petstore: ./openapi/petstore.yaml\n  ultra: ./openapi/ultra-api.yaml\n  max: https://example.com/max/openapi.yaml
\n
\n

Add a page yaml file

\n

This project includes a sample petstore API.\nThere is a file at openapi/reference.page.yaml.

\n

The contents utilize the key petstore defined in the siteConfig.yaml.

\n
\n
\n
Copy
\n
Copied
\n
\n 
type: reference-docs\ndefinitionId: petstore
\n
\n

That provides the additional metadata we need to render the API.

\n

Read the docs about the available properties, and how to utilize this page within the sidebar.

\n

Be sure to add reference to your page in the sidebars.yaml.

\n

Do you see your API reference docs?\nIf not, it may require a yarn clean cache clearing action.

","headings":[{"value":"OpenAPI spec definitions","depth":1},{"value":"Add more OpenAPI definitions","depth":2},{"value":"Add a page yaml file","depth":3}]},"contentItem":{"data":{"lastModified":"2025-12-17T21:55:39.000Z","enableToc":null,"disableLastModified":null,"tocMaxDepth":null,"requestLogin":false}},"siteConfig":{"enableToc":true,"disableLastModified":false,"tocMaxDepth":4}},"pageContext":{"matchPath":"","id":"728b395d-09a4-5fa7-812f-27968691785d__redocly content/developer-portal/oas-definitions/","seo":{"title":"OpenAPI spec definitions","description":null,"image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"developer-portal/oas-definitions.md","pageBaseUrl":"/developer-portal/oas-definitions","type":"markdown","toc":{"enable":true,"maxDepth":4,"headings":[{"depth":1,"value":"OpenAPI spec definitions","id":"openapi-spec-definitions"},{"depth":2,"value":"Add more OpenAPI definitions","id":"add-more-openapi-definitions"},{"depth":3,"value":"Add a page yaml file","id":"add-a-page-yaml-file"}]},"data":{"title":""},"catalogInfo":null,"link":"/developer-portal/oas-definitions/","sidebarName":"","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":null,"apiVersionId":null,"isDefaultApiVersion":null}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}