Endpoints

An endpoint is a group of requests with a similar path.

Use Case

• Required for marking a request component as optional for mock response matching

Types of Endpoints

Fixed Endpoint

A fixed endpoint has a static path that will exactly match a request's path.

• Matching against a fixed endpoint has the highest priority level

Aliased Endpoint

An aliased endpoint has one or more aliases in its path. When an endpoint is aliased, fuzzy matching is applied when grouping requests.

• Matching against an aliased endpoint has lower priority than matching against a fixed endpoint

• Aliased endpoints with a lower number of aliased path segments will have higher matching priority over aliased endpoints with a higher number of aliased path segments

Examples

Given the following endpoint patterns:

1. /users/1

2. /users/:userId

3. /:organizationId/:userId\

Example 1

A request with path /users/1 will be grouped into endpoint 1 because it is a fixed endpoint.

Example 2

A request with path /users/2 will be grouped into endpoint 2 (one aliased path component) and not endpoint 3 (two aliased path components) because it has a lower number of aliased path components.

Example 3

A request with path /stoobly/2 will be grouped into endpoint 3

How To Create

Method 1

In the top right corner of the endpoints page, select the plus icon button.

Endpoints Page

Method 2

On the requests page, right-click a request and in the dropdown menu, select Make Endpoint.

Requests Page Dropdown