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 with Overwrite
        • Updating with Replay
      • 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
  • Background
  • Prerequisites
  • Snapshotting Requests
  • Command
  • Options
  • Snapshotting Scenarios
  • Command
  • Options

Was this helpful?

  1. Guides
  2. How to Mock APIs

How to Snapshot Requests

PreviousEnabling from the CLINextDeleting Snapshots

Last updated 2 months ago

Was this helpful?

Background

Prerequisites

Snapshotting Requests

Command

stoobly-agent request snapshot <REQUEST-KEY>

The following page provides details on how to obtain the request's key:

For our example the request key will be p0.i4a449553b0744782809fe52d8358da78

To add the corresponding request to a snapshot, run the following command with the key like this:

$ stoobly-agent request snapshot --action PUT p0.i4a449553b0744782809fe52d8358da78

Afterwards in your data directory you'll see a new snapshots directory has been created. Here is an example of what that directory looks like:

/home/user/.stoobly/snapshots
├── log
└── requests
    └── 4a
        └── 4a449553-b074-4782-809f-e52d8358da78

Options

$ stoobly-agent request snapshot --help
Usage: stoobly-agent request snapshot [OPTIONS] REQUEST_KEY

  Snapshot a request

Options:
  --action [DELETE|PUT]  Sets snapshot action.
  -h, --help             Show this message and exit.

Snapshotting Scenarios

Command

stoobly-agent scenario snapshot <SCENARIO-KEY>

Options

$ stoobly-agent scenario snapshot --help
Usage: stoobly-agent scenario snapshot [OPTIONS] SCENARIO_KEY

  Snapshot a scenario

Options:
  --action [DELETE|PUT]  Sets snapshot action.
  -h, --help             Show this message and exit.
Snapshots
Install the agent
Create a new Stoobly context
Record requests
Request