Stoobly Docs
  • Introduction
  • Use Cases
    • Generate Mock APIs
      • Empower Development
      • Scale API Testing
    • Enable E2E Testing
  • FAQ
    • Recording
    • Mocking
    • Terminology
  • Getting Started
    • Installing the Agent
      • Installation with pipx
      • Installation with Docker
  • Core Concepts
    • Agent
      • Intercept Modes
        • Mocking
        • Recording
      • Lifecycle Hooks
      • Proxy Settings
        • Data Rules
        • Firewall Rules
        • Rewrite Rules
        • Match Rules
    • Context
    • Mock API
      • Request
        • Response
        • Replay History
      • Scenarios
      • Snapshots
      • Fixtures
      • Public Folder
    • Scaffold
      • Service
      • Validation
      • Workflow
  • Guides
    • How to Run the Agent
      • Run with CLI
      • Run with Docker
    • How to Configure the Agent
      • Forward Proxy
        • Enable HTTPS Traffic
      • Reverse Proxy
    • How to Record Requests
      • Recording from the UI
      • Recording from the CLI
      • How to Create Contexts
      • How to Create Scenarios
        • Creating from the UI
        • Creating from the CLI
      • How to Create Requests
      • How to Customize Recordings
        • Customizing with Lifecycle Hooks
    • How to Update Requests
      • Editing from the UI
      • Editing with Snapshots
      • How to Update Scenarios
        • Updating from the UI
        • Updating from the CLI
      • Updating with Replay
        • Replaying from the UI
        • Replaying from the CLI
        • How to Customize Replays
          • Customizing with Lifecycle Hooks
      • Updating with Open API
    • How to Mock APIs
      • How to Enable Mocking
        • Enabling from the UI
        • Enabling from the CLI
      • How to Snapshot Requests
        • Deleting Snapshots
        • Sharing Snapshots
      • How to Use Fixtures
      • How to Customize Mocking
        • Customizing with Lifecycle Hooks
        • Customizing with Request Headers
      • Troubleshooting
    • How to Replay Requests
      • Replay with the UI
      • Replay with the CLI
    • How to Integrate E2E Testing
      • How to Scaffold an App
        • Scaffolding a Service
        • Customizing a Workflow
          • Customizing Container Services
          • Customizing Lifecycle Hooks
          • Customizing Init Scripts
          • Customizing Configure Scripts
          • Customizing Makefile
        • Troubleshooting
      • How to Run a Workflow
        • Running with CLI command
        • Running with Make
        • Troubleshooting
          • Validating
      • How to Stop a Workflow
        • Stopping with CLI command
        • Stopping with Make
      • How to Update a Scaffold
        • Deleting a Service
      • FAQ
  • Developer Guide
    • Installation from Source
    • Submitting Change Requests
    • Releases
  • Experimental
    • Experimental Features
      • Aliases
      • Endpoints
      • API Testing
        • Getting Started
        • Configuration
          • Assign
          • Lifecycle Hooks
          • Trace
      • Optional Components
Powered by GitBook
On this page

Was this helpful?

  1. Guides
  2. How to Mock APIs
  3. How to Enable Mocking

Enabling from the CLI

1

Access Intercept Command

The intercept command is used to configure the proxy settings with the CLI. In our case, we can use it to configure stoobly-agent to intercept and mock requests.

$ stoobly-agent intercept --help
Usage: stoobly-agent intercept [OPTIONS] COMMAND [ARGS]...

  Manage request intercept

Options:
  -h, --help  Show this message and exit.

Commands:
  configure  Configure intercept
  disable    Disable intercept
  enable     Enable intercept
  show       Show intercept

  Run 'stoobly-agent intercept COMMAND --help' for more information on a
  command.
2

Access Intercept Configure Command

Here's the configure sub-command to configure the proxy mode and policy.

$ stoobly-agent intercept configure --help
Usage: stoobly-agent intercept configure [OPTIONS]

  Configure intercept

Options:
  --mode [mock|record|replay]
  --policy [all|found]
  -h, --help                   Show this message and exit.
3

Configure Intercept Mode

Run that command and set the mode to mock. Optionally add extra --policy flag as needed. Defaults to mocking all requests.

stoobly-agent intercept configure --mode mock
4

Enable Intercept

Next, enable the proxy to start mocking. This is equivalent to pressing the Run button in the UI

stoobly-agent intercept enable
5

Test Intercept

Finally send some requests to the Agent and see your mocked HTTP requests!

6

Cleanup

After you are done with mocking, you can optionally disable the intercept mock mode with:

stoobly-agent intercept disable
PreviousEnabling from the UINextHow to Snapshot Requests

Last updated 1 month ago

Was this helpful?