Workflow
A workflow groups configurations for services to perform distinct use cases. By default, Stoobly provides configurations for the record, mock and test workflows.
Background
To learn more about the role of individual services, see:
ServiceTo run a workflow, see:
How to Run a WorkflowTo validate a workflow, see:
ValidationFile Structure
Any hidden file will be overritten when the scaffold service create command is rerun.
Core Workflows
Record

The journey of a request:
A request gets sent from the host e.g. browser or cURL
Gets sent to the gateway service
Gateway service routes the request based on hostname
Request gets intercepted by Stoobly running as a proxy
Lifecycle hooks get triggered
Stoobly reverse proxies the request to the local or external API
On response, Stoobly records the request to its respective
.stoobly
folderLifecycle hooks get triggered
Mock

The journey of a request:
A request gets sent from the host e.g. browser or cURL
Gets sent to the gateway service
Gateway service routes the request based on hostname
Request gets intercepted by Stoobly running as a proxy
Lifecycle hooks get triggered
Stoobly mocks requests if it has been previously recorded. If the request is not found, it can conditionally reverse proxy the request to the local or external API
Lifecycle hooks get triggered
Test

The journey of a request:
A request gets sent from the entrypoint service
Gateway service routes the request based on hostname
Request gets intercepted by Stoobly running as a proxy
Lifecycle hooks get triggered
Stoobly mocks requests if it has been previously recorded. If the request is not found, it can conditionally reverse proxy the request to the local or external API
Lifecycle hooks get triggered
Last updated
Was this helpful?