OpenAPI Companion

A browser extension that turns OpenAPI/Swagger docs into a persistent, productivity-focused API testing workspace.

Turn Swagger UI into a persistent, productivity-focused API testing workspace — completely offline and private. Tired of re-entering authentication tokens after every page refresh, manually crafting test JSON payloads, losing request parameters, or clicking through endpoints one by one to test multi-step user flows? OpenAPI Companion integrates natively into Swagger UI via the browser Side Panel, giving you a powerful, persistent workspace directly inside your API documentation. ───────────────────────────────────────── WHAT’S NEW IN THIS VERSION ───────────────────────────────────────── • Multi-Step Workflow Runner: Chain API calls into automated sequences (e.g. Register → Login → Create Object → Verify) with live progress streaming and drag-and-drop step reordering. • Inter-Step Data Chaining: Automatically extract dynamic IDs or tokens from earlier responses (e.g. Step 2 POST response body) and inject them into subsequent steps (e.g. Step 4) via {{VARIABLE}} syntax. • Portable Workflow JSON Import / Export: Export workflows to share with teammates or let your IDE AI assistant generate test workflows to import in one click. • Environment Manager & Raw .env Editor: Switch between Local, Staging, and Production with support for Table, Raw .env, and Rules modes. • Zero-Click Response Auto-Extraction: Create extraction rules using JSON dot-paths (data.id, token, items[0].id) to automatically update environment variables after calls. • High Performance & Reliability: Optimized background service worker and responsive side panel interactions. ───────────────────────────────────────── CORE FEATURES ───────────────────────────────────────── 1. MULTI-STEP WORKFLOW RUNNER & AUTOMATION • Build and run multi-step API journeys right from your Swagger page — no external test scripts or third-party tools required. • Swagger Auto-Population: Pre-fill schemas, path parameters, query parameters, and headers directly from active Swagger documentation with one click. • Inter-Step Variable Chaining: Dynamically feed values from earlier response bodies into later requests. • Real-Time Execution Modal: Live animated progress bar, streaming step status (running, success, error), latency counters, and expandable response payloads. • Configurable Failure Modes: Choose between "Stop on failure" (strict regression testing) or "Continue on failure" (batch runs & cleanup routines). • JSON Import & Export: Export portable workflow bundles without internal runtime IDs; import flows with automatic duplicate name conflict handling. 2. ENVIRONMENT MANAGER & AUTO-EXTRACTION • Create named environment profiles (Local, Staging, Production) with dedicated Base URLs and variables. • 3 Editor Modes: - Table Mode: Clean visual key-value editor with secret masking for sensitive credentials. - Rules Mode: Automated response extraction capturing tokens, user IDs, or object IDs from response bodies and headers. - Raw .env Mode: Direct .env file editor with real-time validation, syntax highlighting, and auto-save. • In-Page Trigger: Click the lightning bolt icon next to any Swagger response to create extraction rules on the fly. • Dynamic Variables: Use {{VARIABLE_NAME}} in URL paths, query parameters, headers, and request bodies. • Import and export standard .env files and portable environment configurations. 3. PERSISTENT AUTHENTICATION • Retain authorization across page reloads without re-entering credentials. • Supports Bearer tokens, JSON Web Tokens (JWT), API Keys, and Basic Authentication. • Multi-User Token Store: Save accounts (e.g., Admin, Regular User, Guest) and switch roles in a single click. • Optional automatic token refresh to keep sessions active during testing. 4. REQUEST PRESETS & TEMPLATES • Save frequently used request bodies, query parameters, and headers as named presets. • Insert saved payloads directly into the active endpoint form with one click. • Automatically remembers last-used input values per endpoint. 5. COLLECTIONS & ORGANIZATION • Group endpoints by feature, user journey, microservice, or sprint for fast access. • Add endpoints to collections directly from Swagger UI or the sidebar. • Fully persistent per project. 6. MOCK DATA & DATASET STUDIO • Built-in realistic generators for names, emails, addresses, UUIDs, coordinates, test cards, dates, and numbers. • Schema-Aware Synthesis: Automatically generates request bodies matching your endpoint's schema across four modes: - Realistic: Production-like sample data. - Minimal: Generates only required fields. - Boundary: Tests maximum, minimum, and edge-case values. - QA & Security: Tests input handling with injection patterns and special character sets. • Live Fill: Auto-detects empty input fields in the open Swagger endpoint and fills them instantly. 7. REQUEST HISTORY & INSPECTION • Automatically records executed API calls with timestamps, status codes, response durations, and payloads. • Search and filter past calls by status code or path to review, inspect, or replay earlier requests. • Copy as cURL, Fetch, Axios, PowerShell, or raw body in one click. 8. QUICK NAVIGATION & COMMAND PALETTE • Press Ctrl+K (or Cmd+K on Mac) to search all endpoints instantly by path or summary. • Jump directly to any endpoint on the documentation page without manual scrolling. ───────────────────────────────────────── PRIVACY & SECURITY ───────────────────────────────────────── • 100% Local & Offline: All credentials, history, and presets are stored strictly in your browser's local storage. • Zero Telemetry: No tracking, no external network requests, and no account required. • Non-Intrusive: Runs client-side alongside your existing documentation without touching your backend. ───────────────────────────────────────── HOW TO GET STARTED ───────────────────────────────────────── 1. Install OpenAPI Companion. 2. Open any Swagger UI or OpenAPI documentation page (e.g., http://localhost:8000/docs or https://petstore.swagger.io). 3. Press Ctrl+Shift+O (or Cmd+Shift+O on Mac) or click the extension icon to slide open the side panel. 4. Enjoy a faster, persistent, and automated API testing workflow!