docs
Introduction

DevTools Documentation

DevTools is a powerful API testing and automation platform that helps you build, test, and validate API workflows visually and programmatically.

What is DevTools?

DevTools provides:

  • Visual Flow Builder: Create API test workflows using a drag-and-drop interface
  • HAR Import: Record browser interactions and convert them into executable test flows
  • CLI Tool: Run flows from the command line for CI/CD integration
  • Variables & Environments: Manage configuration across dev, staging, and production
  • Data Flow Mapping: Automatically chain API requests with response data

Key Features

Studio Application

Build and test API flows with an intuitive visual interface:

Download DevTools Studio for macOS, Windows, or Linux.

  • Create HTTP requests with full header, body, and parameter support
  • Chain requests together using response data
  • Add conditional logic, loops, and custom JavaScript transformations
  • Organize requests by domain and workspace

CLI Tool

Execute flows from the terminal for automation and CI/CD:

  • Run YAML-defined flows with the devtools command
  • Generate JUnit and JSON reports for CI systems
  • Use environment variables for secrets and configuration
  • Integrate with GitHub Actions, GitLab CI, Jenkins, and more

Flow-Based Testing

Design complex API test scenarios:

  • Visual dependency graphs showing request execution order
  • Automatic variable extraction from API responses
  • JavaScript nodes for custom data transformations
  • Loop and conditional execution support

Getting Started

Start with these guides to learn DevTools:

  1. Getting Started - Install DevTools and create your first request
  2. Importing HAR Files - Convert browser recordings into flows
  3. Working with Flows - Build visual API test workflows
  4. Environments & Variables - Manage configuration
  5. CLI Tool - Automate flows from the command line
  6. CI/CD Integration - Add to your deployment pipeline
  7. Examples & Best Practices - Real-world patterns

Quick Example

Create a login flow and use the token in subsequent requests:

flows:
  - name: AuthFlow
    steps:
      - request:
          name: Login
          method: POST
          url: '{{BASE_URL}}/auth/login'
          body:
            email: user@example.com
            password: secret
 
      - request:
          name: GetProfile
          method: GET
          url: '{{BASE_URL}}/profile'
          headers:
            Authorization: Bearer {{Login.response.body.token}}

Run with the CLI:

devtools flow run auth-flow.yaml

Data Storage

All data is stored locally on your machine:

  • Studio app uses SQLite in your user data directory
  • No data is sent to external servers
  • You control all test data and credentials

Open Source

DevTools is open source under the Apache-2.0 license and free to use. View the code on GitHub (opens in a new tab).

Installation