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 private, local, and client-side. Tired of re-entering authentication tokens after every page refresh, manually crafting test JSON bodies, losing parameters, or clicking through endpoints one by one to test multi-step user journeys? OpenAPI Companion integrates directly into Swagger UI and the native browser Side Panel, giving you a powerful, persistent workspace right inside your API documentation. ───────────────────────────────────────── WHAT’S NEW IN VERSION 1.1.4 ───────────────────────────────────────── • Multi-Step Scenario Workflow Runner: Chain API calls into automated sequences (e.g., Register → Login → Create Item → Verify) with real-time progress indicators and drag-and-drop step reordering. • Inter-Step Data Chaining: Automatically extract dynamic IDs or tokens from earlier responses and inject them into subsequent steps using {{VARIABLE}} syntax. • Native Variable Autocomplete: Type {{ directly into Swagger UI inputs, query parameters, path fields, and request bodies for live autocomplete and seamless execution-time resolution. • Pinned Operations Tray: Star your favorite endpoints to pin them into an easily accessible tray at the top of Swagger UI for quick 1-click access. • Paste cURL to Auto-Fill: Paste raw cURL commands directly into Swagger UI to automatically select the matching route and populate headers, parameters, and bodies. • Global Debug Headers: Inject persistent custom HTTP headers (such as X-Tenant-ID, X-Debug, or trace IDs) globally across all native documentation requests. • Collapsible Response JSON Tree Viewer: Explore complex response payloads with an interactive tree viewer, text search, and 1-click export to JSON or CSV. • Encrypted Backups: Passphrase-protect your exported environments and presets using industry-standard AES-GCM encryption with automatic credential sanitization. ───────────────────────────────────────── CORE CAPABILITIES ───────────────────────────────────────── 1. MULTI-STEP WORKFLOW RUNNER & AUTOMATION • Build, organize, and execute end-to-end API workflows directly from your documentation page. • Documentation Auto-Population: Pre-fill schemas, path parameters, query parameters, and headers directly from active endpoints with a single click. • Inter-Step Variable Chaining: Dynamically pass values from earlier response bodies into subsequent request parameters or headers. • Real-Time Execution Modal: Live progress tracking, step status badges (running, success, error), execution latency metrics, and expandable payload inspection. • Configurable Execution Modes: Select "Stop on failure" for strict verification or "Continue on failure" for batch processing and cleanup routines. • Portable Workflow Bundles: Export workflows to share with teammates or import flows with automatic naming conflict resolution. 2. IN-PAGE SWAGGER PRODUCTIVITY ENHANCEMENTS • Pinned Endpoints: Star frequently tested endpoints to keep them anchored at the top of the page. • Paste cURL Autofill: Converts pasted terminal cURL requests into populated Swagger forms instantly. • Global Request Headers: Define global headers that automatically attach to all requests executed from the page. • Multi-Language Code Snippets: Copy ready-to-use code directly from endpoints formatted as cURL, Fetch, Axios, PowerShell, or Python. • Response Data Export: Download executed responses in structured JSON or CSV format. • Quick Payload Refill: Re-fill the last sent request body for any endpoint in one click. 3. ENVIRONMENT MANAGER & DYNAMIC VARIABLES • Create multiple environment profiles (Local, Staging, Production) with dedicated Base URLs and variables. • 3 Powerful Editor Modes: - Table Mode: Clean key-value editor with masking for sensitive secrets and tokens. - Raw .env Mode: Full-featured .env editor with syntax highlighting, auto-save, and formatting validation. - Rules Mode: Define zero-click extraction rules to automatically parse and save values from response bodies or headers. • In-Page Variable Resolution: Use {{VARIABLE_NAME}} in URL paths, query parameters, headers, and request bodies. 4. PERSISTENT AUTHENTICATION & ROLE SWITCHER • Retain authorization across page reloads without repeatedly re-entering credentials. • Supports Bearer tokens, JSON Web Tokens (JWT), API Keys, and Basic Auth. • Multi-Account Switcher: Save distinct roles (e.g., Admin, Regular User, Guest) and switch accounts on the fly right beside Swagger's native Authorize button. • Automatic Session Renewal: Optional auto-refresh to keep active sessions authenticated during testing. 5. SMART MOCK DATA GENERATOR • Built-in schema-aware generators for realistic names, emails, addresses, UUIDs, dates, numbers, and timestamps. • Multiple Generation Modes: - Realistic: Generates lifelike sample data according to field types. - Minimal: Populates required fields only. - Boundary: Tests maximum, minimum, and edge-case limits. - Robustness: Tests input resilience with special character sets and varied data lengths. • Auto-Fill: Detects open parameter fields and populates them instantly. 6. REQUEST PRESETS & TEMPLATES • Save frequently used request bodies, query parameters, and custom headers as named presets. • Insert saved presets directly into open endpoint forms with one click. • Automatically remembers last-used inputs per endpoint. 7. REQUEST HISTORY & REPLAY • Automatically records executed calls with timestamps, HTTP status codes, durations, and payloads. • Search and filter past requests by endpoint path or status code. • Inspect headers and bodies or replay requests with a single click. 8. INSTANT COMMAND PALETTE & NAVIGATION • Press Ctrl+K (or Cmd+K on macOS) to search all endpoints instantly by path, method, or summary description. • Jump directly to any endpoint on the documentation page without manual scrolling. ───────────────────────────────────────── PRIVACY & SECURITY FIRST ───────────────────────────────────────── • 100% Local Storage: All tokens, variables, history, and presets remain strictly inside your browser's local storage (`chrome.storage.local`). • Zero Telemetry: No external tracking, no analytics, no remote servers, and no account required. • Non-Intrusive: Runs client-side alongside your existing documentation without modifying backend services. • Encrypted Export: Protect backups with user-defined passphrases using AES-GCM encryption. ───────────────────────────────────────── HOW TO GET STARTED ───────────────────────────────────────── 1. Add OpenAPI Companion to your browser. 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 (Cmd+Shift+O on macOS), click the extension icon, or click the floating launcher button in the bottom-right corner to open the Side Panel. 4. Enjoy a faster, persistent, and automated API testing workspace!