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:

Service

To run a workflow, see:

How to Run a Workflow

To validate a workflow, see:

Validation

Core Workflows

Record

Flow diagram for recording requests

The journey of a request:

1. A request gets sent from the host e.g. browser or cURL

2. Gets sent to the gateway service

3. Gateway service routes the request based on hostname

4. Request gets intercepted by Stoobly running as a proxy

   1. Lifecycle hooks get triggered

5. Stoobly reverse proxies the request to the local or external API

6. On response, Stoobly records the request to its respective .stooblyfolder

   1. Lifecycle hooks get triggered

Mock

Flow diagram for mocking requests

The journey of a request:

1. A request gets sent from the host e.g. browser or cURL

2. Gets sent to the gateway service

3. Gateway service routes the request based on hostname

4. Request gets intercepted by Stoobly running as a proxy

   1. Lifecycle hooks get triggered

5. 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

   1. Lifecycle hooks get triggered

Test

Flow diagram for testing an application that sends requests

The journey of a request:

1. A request gets sent from the entrypoint service

2. Gateway service routes the request based on hostname

3. Request gets intercepted by Stoobly running as a proxy

   1. Lifecycle hooks get triggered

4. 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

   1. Lifecycle hooks get triggered