Mock API Component
Create a stateless mock API URL from pipeline output; set its method, status, headers and response format, and resolve placeholders dynamically per request.
Last updated:
The Mock Output node creates a Mock API URL from the result of its connected input. The URL contains a compressed snapshot of the response and its settings; the pipeline does not register or host a live dataset on a server.
Configuration
| Setting | Behavior |
|---|---|
| Response body source | Use the connected pipeline result or a custom template configured on the node. |
| HTTP method | Restrict requests to the selected method. |
| Status | Return the configured HTTP status. |
| Content type | Set the response Content-Type header. |
| Delay | Add latency before returning a response. |
| Headers | Add the configured response headers. |
| Default params | Supply fallback values for matching interpolation placeholders. |
| Response format | Keep the JSON or NDJSON body format inferred from the source template. |
The node keeps interpolation placeholders such as {{faker.person.fullName()}}, {{query.page}}, and {{body.username}} in the response. They are resolved for each HTTP request. JSON or NDJSON data passed through a Transform or Script node is serialized into the configured body format before the URL is created.
Creating and using the endpoint
Run the pipeline, then use the Mock Output node's link action. GET endpoints can open in a browser tab. For POST, PUT, PATCH, or DELETE endpoints, use the URL with the matching request method in the Mock API simulation, curl, or an API client.
Each URL is a snapshot. Running the pipeline again may produce a different response and a new URL; previously copied URLs continue to return their earlier snapshot.
Standalone Mock API workflows
The standalone Mock API offers two starting recipes when its body is valid JSON or NDJSON:
- Transform and mock creates JSON/NDJSON Input → Transform → Mock Output. The Transform node starts with mappings that preserve the current fields and can then be edited.
- Script and mock creates JSON/NDJSON Input → Script → Mock Output. The script starts with return input; and is ready to customize.
Both recipes copy the current method, status, content type, delay, headers, default params, and interpolation template into the Mock Output node. The node uses the result of Transform or Script as its response body. Raw XML, HTML, or plain-text templates cannot be used as structured pipeline input.
The pipeline is a temporary, editable copy in this browser tab. Changes to the pipeline do not change the saved standalone Mock API session.
Workspace Mock API
A Workspace Mock API node can use the shared workspace configuration. Promoting a node's configuration to the workspace replaces those shared Mock API settings.