search

Redocly / developer-portal-starter

Starter template for the Redocly developer portal
https://redoc.ly
Other
64 stars 101 forks source link

demo: show adding an API from the registry #35

Closed adamaltman closed 2 years ago

adamaltman commented 4 years ago

Three steps:

  1. Add registry snapshot URL to siteConfig.yaml (how to find your snapshot URL)
  2. Add special .page.yaml file (I named the one below example.page.yaml -- the name must end in .page.yaml (so I could have named it anything.page.yaml but I could not name it anything.yaml.)
  3. Add to sidebars.yaml (this isn't technically required, but if you want it to display in the sidebar then it would be required).

Prerequisites:

Having your API(s) in the API registry.

Note: if your API registry definition is private, to run the developer portal in your local environment, you will need to use the openapi-cli login command prior to yarn start to run the portal.

RomanHotsiy commented 2 years ago

This is outdated. Closing it.