API Mocking
Endpoints and Scenarios
Methods, path matching, response scenarios, headers, and delays.
Endpoints and Scenarios
This guide covers endpoint design and response scenario control.
Endpoint Setup
Define these endpoint properties:
- HTTP method
- Path
- Activation status
- Optional linked datasource
Scenario Design
Each endpoint can have multiple scenarios.
Scenario Fields
- Status code
- Response body
- Request conditions
- Priority
- Delay in milliseconds
- Default scenario flag
Request Conditions
Conditions let you return different responses for the same endpoint.
Common Condition Targets
- Header value
- Query parameter
- Request body property
Headers
You can set request and response headers at endpoint/scenario level.
Delay Simulation
Use delay to mimic network latency, queueing, or third-party slowness.
Priority and Defaults
- Higher-priority scenarios should match first.
- Default scenario acts as fallback when no condition matches.
Testing Pattern
- Create baseline success scenario.
- Add validation-error scenario.
- Add unauthorized scenario.
- Add timeout or latency scenario.
- Validate each with real client requests.