The developer portal may contain multiple API definitions.
Define that in the
oasDefinitions: petstore: ./openapi/petstore.yaml
Notice that the petstore is pointing to an API definition on the local filesystem.
For a great docs-like-code experience, we recommend pointing to our API registry links. That will cause any update to those API definitions to trigger an update to your developer portal.
A private definition can be accessed locally by using the OpenAPI CLI login command.
This is outside of the scope of this training exercise.
Follow the example here, but utilize your own API definitions and rename them accordingly. If your API definitions are accessible by URL, you may use those. Or else, add it to the local file system.
oasDefinitions: petstore: ./openapi/petstore.yaml ultra: ./openapi/ultra-api.yaml max: https://example.com/max/openapi.yaml
This project includes a sample petstore API.
There is a file at
The contents utilize the key
petstore defined in the
type: reference-docs definitionId: petstore
That provides the additional metadata we need to render the API.
Read the docs about the available properties, and how to utilize this page within the sidebar.
Be sure to add reference to your page in the
Do you see your API reference docs?
If not, it may require a
yarn clean cache clearing action.