Mock servers

About this feature

The mock server feature is only available to Pro and Enterprise customers.

Only users with the Admin project-level role for an API can enable the mock server feature.

The mock server feature is disabled by default.

To enable the mock server:

  1. On the API registry page, select the API for which you want to enable mock server feature. The API Overview page displays.
  2. From the top, navigate to Settings > Mock servers .
  3. Check the Enable mock servers for all branches box.

To further control the mock server behavior, use the features.mockServer section in your Redocly configuration file. Note that you must add the configuration file to your API project in the registry for settings to apply.

Read more on how to use the mock server feature.