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
  • Examples
  • Example 1
  • Example 2
  • How To Create
  • Method 1
  • Method 2

Was this helpful?

  1. Experimental
  2. Experimental Features

Aliases

As your project grows, certain endpoints may have path components that can be substituted for different values. We call these "wildcard" path components aliases.

Use Case

  • Provides a rule to fuzzy match requests with similar paths to a common endpoint

Examples

Let's say we have the requests with paths /users/1, /users/2, /users/100, etc... and we want to group them together. To capture this behavior when creating an endpoint, mark the :user_id path component as an alias.

Example 1

The following endpoint with :user_id marked as an alias will match /users/1, /users/2, /users/100, etc...

/users/:user_id

Example 2

The following endpoint with :username and :repository marked as an alias will also matches requests with the paths/users/1, /users/2, /users/100, etc...

/:username/:repository

This creates an ambiguous situation where it is unclear whether the paths belong to the endpoint in Example 1 or the endpoint in Example 2. To address the ambiguity we match requests to viable endpoints with the least number of aliases, which would be the endpoint from Example 1.

How To Create

Method 1

When creating an endpoint, you have the option to configure path segment(s) as an alias. To configure an alias, select the dropdown menu to the right of the designated path segment.

Method 2

After creating an endpoint, you also have the option to configure path segment(s) as an alias. To configure an alias, select the pencil icon button underneath the Alias column for the desired path segment.

PreviousExperimental FeaturesNextEndpoints

Last updated 3 months ago

Was this helpful?

Endpoints Create Modal
Endpoint Details Page