REST Endpoints

Applies to ReadyAPI 3.5, last modified on January 19, 2021

On the Endpoints page, you can define any number of endpoints for your service.

The Endpoints page

Click the image to enlarge it.

To open the page:

  1. Double-click a service in the Navigator.

  2. Switch to the Endpoints page.

On this page, you can configure endpoint options. These options are available in the table.

The table includes the following columns:

Option Description
Endpoint The endpoint URL or destination.
Username The authorization username.
Password The authorization password.
Domain The authorization domain.
Mode The endpoint mode.
Possible values: OVERRIDE, COMPLEMENT, COPY.
  • OVERRIDE – Use the specified endpoint value when an endpoint is specified in the request.

  • COMPLEMENT – Use the endpoint value only when it has not been set in the request.

  • COPY – Use this endpoint for all requests.

Add Endpoints

To add a new endpoint:

  1. Click .

  2. In the follow-up dialog, enter a new endpoint URL. Click OK.

  3. If necessary, enter a username, password, and domain.

  4. Select a mode.

Delete Endpoints

To delete an endpoint:

  1. Select an endpoint in the table.

  2. Click .

  3. In the subsequent dialog, click Yes.

Assign Endpoints to Requests

You can assign endpoints to a large number of requests:

  1. Select an endpoint.

  2. Click Assign on the toolbar.

  3. In the subsequent dialog, select one of the following options from the drop-down list:

    The Assign Endpoint dialog
    Option Description
    All Interface Requests Assigns the selected endpoint to all requests in the interface.
    All Test Requests Assigns the selected endpoint to all REST Request test steps in the project.
    All Interface Requests and Test Requests Assigns the selected endpoint to all requests in the interface and REST request test steps in the project.
    All Requests with no endpoint Assigns the selected endpoint to all requests without an endpoint.
  4. Click OK.

Assign Endpoints in Test Runner

You can assign any endpoint to any request before starting the test run using the built-in functional, security or performance test runner. This can be done in the following ways:

  • Specify a value after the -e argument when constructing the command-line test launch string.

  • In the GUI of the test runner, specify the endpoint on the Overrides tab, in the Endpoint field.

Any values you specify in the test runner override those you have specified in the project settings.

To learn more about ReadyAPI test runners, see one of the following topics depending on the application you are working in:

See Also

REST Service Editor

Highlight search results