OpenAPI Companion

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

A persistent, productivity-focused API testing workspace for Swagger UI and OpenAPI documentation — local-first, private, 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 flows? OpenAPI Companion integrates seamlessly with Swagger UI and the native browser Side Panel, giving developers a persistent, powerful workspace directly alongside their API documentation. ======================================== WHAT’S NEW IN VERSION 1.2.1 ======================================== • Workspaces & Port Switcher Redesign: Redesigned as modern card components with visual port chips (:8000, :8008, :8009), an emerald "● this tab" indicator, 1-click workspace switching, and direct secondary port disconnection (✕) without page reloads. • In-App Safe Update Alerts: Surfaces a non-intrusive alert banner when an extension update is ready, enabling 1-click safe reloads without losing local storage, projects, history, or variables. • In-Page Project Variables Modal (Alt+V): Inspect, search, add, and edit project variables in a spacious overlay directly over Swagger UI, complete with instant blur auto-save and password masking. • First-Time Onboarding Walkthrough: Friendly welcome flow guiding new developers through core workspace capabilities with an instant skip option. • In-Page Feedback & Bug Reporter: Share feature suggestions or report issues with an interactive 5-star rating directly within Swagger UI, complete with background worker CORS/CSP bypass and offline queueing. • Active Tab Reopen Persistence: Remembers and restores the exact active tab you were working on when reopening the Side Panel or Floating Sidebar. • History Chronological Call Indexing: Numbered execution calls (#1 to #N) with instantaneous 0ms in-place call switching without full-screen spinners. ======================================== CORE CAPABILITIES ======================================== 1. SMART WORKSPACES & PORT RESILIENCE • Modern Card-Based Switcher: View and organize all your local and remote API environments in clean visual cards. • Zero-Friction Port Switching: Moving between local development ports (:8000, :8008, :8009) or domains preserves all tokens, history, and presets. • Connected Port Chips: View all active URLs and ports associated with each project workspace at a glance. • Granular Port Disconnection: Disconnect non-active ports directly via subtle ✕ buttons on port chips without reloading the page. • Custom Workspace Naming: Name and rename your workspaces (e.g., "Auth Service", "Payment API") with inline editing. • In-Page Swagger Overlay: Spacious top-centered dialog (#oac-project-switcher-host) over Swagger UI instead of a cramped sidebar view. 2. IN-PAGE SWAGGER FEEDBACK & BUG REPORTER • Centered Shadow DOM Modal: Submit feedback and report bugs directly on your active Swagger documentation page. • 5-Star Experience Rating: Interactive rating with context-aware feedback categories (💡 Feature Idea, 🐛 Bug Report, 💬 General). • Background Worker Delivery: Submissions are routed through the background service worker to reliably bypass webpage CORS and CSP limitations. • Resilient Offline Queue: Automatically caches submissions locally if offline, flushing automatically upon reconnection. 3. ENVIRONMENT MANAGER & IN-PAGE VARIABLES (ALT+V) • Dedicated Project Variables scoped 1-to-1 with your active API host. • Quick Variable In-Page Modal (Alt+V): Edit, search, copy, and create project variables directly over the documentation with instant blur auto-save. • Secret Password Masking: One-click reveal toggle for sensitive tokens and keys, with one-click {{KEY}} tag copying. • Zero-Click Auto-Extraction: Define extraction rules to automatically parse and save dynamic tokens and IDs from response bodies into variables. • In-Page Variable Resolution: Use {{VARIABLE_NAME}} in URL paths, query parameters, headers, and request bodies. 4. API RESPONSE COMPARATOR & DIFF • Side-by-Side Split View: Compare any two past calls from your history timeline with synchronized vertical scrolling. • Unified Diff Mode: Toggle between a dual split-pane view and a compact unified single-column view with an "Only changes" filter. • Multi-Tab Comparison: Inspect deltas across Response Body (JSON), Request Body, HTTP Headers (Added / Removed / Changed), and Query/Path Parameters. • Performance Metrics Delta: Immediate visual comparison of HTTP status codes, execution duration delta (ms / %), and payload byte size changes. 5. 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 extract values from earlier response bodies and inject them into subsequent request steps. • 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. 6. IN-PAGE SWAGGER PRODUCTIVITY ENHANCEMENTS • Native Variable Autocomplete: Type {{ directly into Swagger UI inputs, query parameters, path fields, and request bodies for live autocomplete. • Pinned Endpoints Tray: Star frequently tested endpoints to keep them anchored at the top of Swagger UI for quick 1-click access. • Paste cURL Autofill: Converts pasted terminal cURL requests into populated Swagger forms instantly. • Global Request Headers: Define persistent global headers (such as X-Tenant-ID or trace IDs) 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. 7. 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. 8. 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. 9. 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. 10. REQUEST HISTORY & REPLAY • Chronological Call Numbering: View past calls sequentially (#1 to #N) with 0ms in-place inspector switching. • 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, compare against previous executions, or replay requests with a single click. 11. AUTOMATED BACKUPS & SMART MERGE IMPORT • Recurring Background Backups: Scheduled automatic exports via background alarms with zero overhead. • Smart Delta Detection: Automatically skips backup operations if no project data was mutated. • Pre-Import Safety Snapshot: 1-click "Undo Import" rollback if you import an unintended backup file. • Encrypted Exports: Optional passphrase protection for backup files using industry-standard AES-GCM encryption. 12. 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 ======================================== • Local-First Storage: All API credentials, tokens, variables, history, and presets remain strictly inside your browser's local storage. • Private & Client-Side: Runs client-side alongside your existing documentation without modifying backend services or routing API calls through third-party servers. • No Unsolicited Telemetry: Feedback and suggestions are only transmitted when you explicitly choose to submit the feedback form. • Passphrase-Protected Backups: Protect your exported JSON configuration files with user-defined passphrases. ======================================== 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! ======================================== DISCLAIMER ======================================== OpenAPI Companion is an independent developer productivity extension and is not affiliated with, sponsored by, or endorsed by SmartBear Software, Swagger, or the OpenAPI Initiative. Swagger is a registered trademark of SmartBear Software.