Skip to main content

Blueprints

Blueprints are reusable simulation templates that let you standardize and share mock API configurations across your organization. Previously called "Systems", blueprints capture a complete simulation setup that you can version, publish, and deploy repeatedly.

What is a Blueprint?​

A blueprint packages a simulation's routes, responses, configuration, and behavior into a template. Use blueprints to:

  • Standardize mock API patterns across teams
  • Version simulation configurations as your API evolves
  • Share proven mock setups across your organization
  • Onboard new team members with ready-to-use templates
  • Connect related simulations with StageAssist for cross-blueprint intelligence

Creating a Blueprint​

From an Existing Simulation​

  1. Open a simulation you want to template
  2. Click the Blueprint menu in the top bar
  3. Select Save as Blueprint
  4. Configure the blueprint:
    • Name - Descriptive name for the template
    • Description - What API or use case this blueprint simulates
    • Version - Semantic version (e.g., 1.0.0)
    • Visibility - Private (your workspace) or Organization (shared)
  5. Click Create Blueprint

Your simulation is now saved as a reusable template. The original simulation remains unchanged.

From Scratch​

  1. Navigate to Blueprints in the sidebar
  2. Click New Blueprint
  3. Define routes, responses, and configuration
  4. Save and publish to the library

Managing Blueprints​

Access the blueprints page at /blueprints to view all blueprints in your workspace.

Blueprint List View​

Each blueprint card shows:

  • Blueprint name and description
  • Version number
  • Author and creation date
  • Number of routes
  • Deployment count (how many simulations use this blueprint)

Versioning​

Update a blueprint without breaking existing deployments:

  1. Open the blueprint
  2. Make changes to routes or configuration
  3. Click Publish New Version
  4. Enter a version number (follows semantic versioning)
  5. Add release notes describing changes

Simulations using older versions continue to work. Teams can upgrade at their own pace.

Blueprint Library​

The blueprint library at /blueprints/library is a shared repository of organization-wide templates.

Browsing the Library​

  • Search - Find blueprints by name or description
  • Filter - By category, author, or popularity
  • Sort - By creation date, usage count, or rating

Adopting a Blueprint​

To use a blueprint from the library:

  1. Browse to /blueprints/library
  2. Find the blueprint you need
  3. Click Use Blueprint
  4. Choose deployment option:
    • Create Simulation - Deploy as a new simulation
    • Fork Blueprint - Create an editable copy in your workspace
  5. Configure simulation details (name, base path)
  6. Click Deploy

Your simulation is created from the blueprint template and ready to use.

Forking a Blueprint​

Forking creates an editable copy in your workspace:

  1. Select a blueprint from the library
  2. Click Fork
  3. The blueprint is copied to your workspace
  4. You can modify routes and configuration
  5. Optionally publish your modified version back to the library

Publishing to the Library​

Share your blueprint with the organization:

  1. Open a blueprint in your workspace
  2. Click Publish to Library
  3. Add metadata:
    • Category - API type or use case
    • Tags - Searchable keywords
    • Documentation - Usage instructions and examples
  4. Click Publish

The blueprint appears in the organization library for others to discover and use.

Cross-Blueprint Intelligence with StageAssist​

Link related blueprints to give StageAssist context about API dependencies.

Linking Blueprints​

  1. Open a blueprint
  2. Navigate to the Links tab
  3. Click Add Blueprint Link
  4. Select a related blueprint (e.g., Auth API links to User API)
  5. Describe the relationship
  6. Save

StageAssist uses these links to:

  • Generate consistent mock data across related APIs
  • Suggest routes that match linked blueprints
  • Detect conflicts between dependent simulations

Blueprint Settings​

Access blueprint settings via the gear icon:

Metadata​

  • Name, description, and version
  • Author and creation date
  • Tags and categories

Permissions​

  • Private - Only you can view and use
  • Workspace - Available to your workspace
  • Organization - Published in the shared library
  • Public - (Enterprise) Shareable via public link

Deployment Options​

  • Default base path
  • Required environment variables
  • Suggested response delays
  • CORS and state management defaults

Best Practices​

Version meaningfully - Use semantic versioning. Breaking changes should increment the major version.

Document thoroughly - Include usage examples and configuration instructions. Future you (and your team) will thank you.

Start small - Create blueprints for frequently-used patterns first. Don't try to template everything at once.

Link dependencies - Connect related blueprints so StageAssist understands your API architecture.

Review before publishing - Test the blueprint in a fresh simulation before sharing organization-wide.

Next Steps​