{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"test-apis-using-replay","__idx":0},"children":["Test APIs using Replay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Make API calls directly from the API reference documentation in your project."," ","Projects that contain API documentation, typically have Replay - the tool you can use to try out (test) API requests."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use Replay to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["edit any field in sample requests, unrestricted by API description schemas"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["save requests and view request history"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set up and use different environments with customizable variables"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["connect Replay to your live servers, the built-in mock server, or another environment"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["use realistic mock responses for API development and integrations"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"access-replay","__idx":1},"children":["Access Replay"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Access Replay in your reference documentation by clicking the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Try it"]}," button for a request."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the Replay interface opens, it overlays the API reference documentation page you were on originally."," ","Replay is split into two panels, ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Request"]}," and ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["History"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Alternatively, some documentation pages may have an embedded Replay console that is tied to a specific description file."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"use-the-request-pane","__idx":2},"children":["Use the Request pane"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Request pane is located on the left side of Replay and includes everything needed to make a request for an endpoint from your API description."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"send-a-sample-request","__idx":3},"children":["Send a sample request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To send a sample request, enter the required parameters and click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Send"]}," button."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"response-pane","__idx":4},"children":["Response pane"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["After you have sent a sample request, a sample response displays in the bottom of the Request pane."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The sample response is based on example responses included in your API description and can include the following information:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a status code, response time, and size"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["a response body in either JSON, text, HTML, or XML"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["response headers and values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["response cookies"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Copy"]}," icon on the right side of the pane to copy the sample response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"work-with-environments","__idx":5},"children":["Work with environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Environments combine server URLs with their associated inputs to enable making API calls with a defined set of parameters."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Projects can have one or more environment defined in the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["servers"]}," part of their API description files, and a generic mock server in the project's configuration."," ","Users can create custom environments or edit the properties of automatically-generated environments."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"switch-between-environments","__idx":6},"children":["Switch between environments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When testing API calls, you can switch between environments."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To switch to a different environment:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Replay's top-right corner, click the drop-down list and select an environment."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"add-an-environment","__idx":7},"children":["Add an environment"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Replay's top-right corner, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," icon."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," window's bottom-left corner, click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["New environment"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter a name for the environment and confirm."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server"]}," field, hover over ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enter the server's URL and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["(Optional) Expand the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server variable"]}," field and enter values for server variables."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["(Optional) In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inputs"]}," table you can:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Add new inputs and their values."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Edit values of existing inputs."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Set inputs values to secret."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Delete user-added inputs."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"edit-environment-properties","__idx":8},"children":["Edit environment properties"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can edit user-created environments to better suit your needs:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To rename the environment, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]}," icon on the left side of an open environment."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To change the server URL, in the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server"]}," field, hover over ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Edit"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["To set values for server variables, expand the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Server variable"]}," field and enter values for server variables."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Inputs"]}," table you can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["add new inputs and their values"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["edit values of existing inputs"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["set input values to secret"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["delete user-added inputs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"set-an-environment-as-active","__idx":9},"children":["Set an environment as active"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can set any environment as active."," ","Requests are sent to the active by default."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Replay's top-right corner, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," icon."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the environments list, hover over the the chosen environment's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," icon and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Set as active"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"delete-an-environment","__idx":10},"children":["Delete an environment"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can delete user-created environments."," ","This operation is irreversible."]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Replay's top-right corner, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Environments"]}," icon."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the environments list, hover over the the chosen environment's ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["More options"]}," icon and click ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Remove environment"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"history-panel","__idx":11},"children":["History panel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replay keeps a history of your past requests, so you can go back to an earlier API call."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["History is a list of requests you made in Replay."," ","It displays requests you made in reverse chronological order: latest requests at the top of the list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Requests are grouped by date and display the status code of the response."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-the-request-history","__idx":12},"children":["Search the request history"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["History"]}," panel has a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search"]}," filed you can use to find specific requests."," ","You can enter either the request method or a part of the request payload as the search query."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"clear-request-history","__idx":13},"children":["Clear request history"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can delete a single request from history or clear the entire request history."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To delete a request from history:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["History"]}," panel, hover over a request and click the trashcan icon."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To delete the search history:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["History"]}," panel, on the left side of the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search"]}," field, click the broom icon."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"collapse-the-history-panel","__idx":14},"children":["Collapse the History panel"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["You can hide the History panel to make the pages better fit smaller screens."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To collapse the History panel:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["In Replay's bottom-left corner, click the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Collapse panel"]}," button."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"return-to-the-reference-documentation","__idx":15},"children":["Return to the reference documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["From the Request pane you can click the request link at the top of the page to open the API reference documentation for that request in another tab."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Otherwise, if you want to see the reference documentation, you can close Replay using the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["X"]}," icon on the top left side of the Request pane."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":16},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/end-user/interact-with-api"},"children":["Interact with API documentation"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/end-user/test-apis-cli"},"children":["Test APIs using CLI"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/end-user/use-classic-catalog"},"children":["Use a classic catalog"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Explore other ways you can interact with the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/end-user"},"children":["user interface"]}]}]}]},"frontmatter":{},"tagList":[],"title":"Test APIs using Replay","lastModified":"2025-11-10T18:31:27.000Z"}