Last updated

Replay the API explorer

Replay the API explorer allows your users to make API calls directly from the API reference documentation in your project. By using the OpenAPI description, Replay presents users with an interactive API client to make requests to either your API, a sandbox, or the built-in mock server.

Click "Try It" on any operation in your Redoc reference docs to open Replay for this request.

Replay uses the API description and mockServer configuration in your redocly.yaml file to create an interactive interface for your API users.

Make an API request with Replay

Interactive API client

Use Replay to explore an API, with fully editable template requests and responses that match your API description. Replay keeps a history of your past requests, so you can go back to an earlier API call.

Connect Replay to your live servers, the built-in mock server, or another environment. The mock server uses a combination of your API description and the user input to produce realistic responses to make API development and integrations a much smoother experience.

Setup tasks

For Replay the API explorer to send requests, you must have configured the following in your OpenAPI description:

  • Security schemas
  • Servers
Servers must support CORS

Your servers must support CORS (cross-origin resource sharing) requests, or you can configure a CORS proxy using the openapi.cors-proxy-url configuration option in your redocly.yaml file.

You can also use our mockServer, which can also be configured in the redocly.yaml file.

User tasks

Users can complete the following tasks with Replay the API explorer:

  • Edit any field in sample requests, unrestricted by API description schemas
  • Save requests and view request history
  • Set up and use different environments with customizable variables

Resources

 
Next page