OpenAPI Companion

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.3.0 ======================================== • Multi-Persona Authentication & Dynamic Payload Fields: Configure non-standard or mandatory login parameters (e.g. force_logout: true, tenant_id, role) with dynamic type casting (string, boolean, number) directly in the Auth Vault. • Native Auto-Token Capture & Direct Authorization: Sending or replaying login requests automatically detects 2xx responses, extracts bearer tokens, and applies them to Swagger UI's authorization header with zero copy-pasting. • OpenAPI Spec Change Detector & Impact Analysis: Automatically compares active API docs with cached schemas, alerting you to altered endpoints, removed parameters, and potential breaking changes. • Automated Pagination Tester & Export: Test cursor-based, page/limit, and offset/limit pagination flows with automated record fetching, integrity checks, and 1-click JSON/CSV export. • API Scenario Recorder & Visual Workflow Editor: Record live endpoint executions directly from documentation pages into reusable automated test workflows with drag-and-drop step management. • Rich Assertions Engine: Validate status codes, latency thresholds, headers, regex patterns, and nested JSONPath queries (e.g., $.data.items[0].id). • Refreshed Keyboard Shortcuts: - Press Ctrl+F (or Cmd+F on macOS) for the instant Command Palette endpoint search. - Press Ctrl+K (or Cmd+K on macOS) for the Keyboard Shortcuts Manager and cheat-sheet. • Seamless Sidepanel Hot-Reloading: Automatically detects extension build updates and refreshes the panel without requiring full tab reloads. ======================================== CORE CAPABILITIES ======================================== 1. MULTI-PERSONA AUTHENTICATION & AUTO-TOKEN CAPTURE • Retain authorization across page reloads without repeatedly re-entering credentials. • Supports Bearer tokens, JSON Web Tokens (JWT), API Keys, and Basic Auth. • Multi-Persona Vault: Save distinct credentials and roles (e.g. Admin, Support, Guest, Tenant Admin) right beside Swagger's Authorize button. • Custom Login Payload Fields: Add custom fields such as force_logout: true, client_secret, or tenant_id with strict typing. • Zero-Click Token Extraction: Executing login endpoints parses successful tokens and authorizes Swagger UI immediately. • Automatic Session Renewal: Automated background token refresh keeps active sessions valid during testing. 2. MULTI-STEP WORKFLOW RUNNER & SCENARIO RECORDER • API Scenario Recorder: Floating recording toolbar captures real API interactions on docs pages into structured test workflows. • Visual Step Editor: Drag, reorder, and configure multi-request flows with inter-step variable propagation. • Dynamic Value Chaining: Extract values from earlier responses (e.g. created resource IDs) and inject them into downstream steps. • Real-Time Execution Inspector: Step-by-step progress, latency metrics, status badges, and expandable payload inspection. • Configurable Failure Behavior: Choose "Stop on failure" for strict verification or "Continue on failure" for batch processing. • Portable Workflow Bundles: Export and share workflows with teammates via JSON bundles. 3. AUTOMATED PAGINATION TESTER & EXPORT • Deep Pagination Verification: Validates cursor-based, page/limit, and offset-based pagination endpoints. • Automated Data Fetching: Automatically traverses sequential pages up to configured record or page limits. • Integrity & Deduplication Analysis: Detects duplicate identifiers, gap issues, and empty pages. • Structured Export: Download aggregated paginated datasets directly as structured JSON or CSV. 4. OPENAPI SPEC CHANGE DETECTOR & IMPACT ANALYSIS • Automatic Spec Diffing: Compares newly loaded API documentation against historical snapshots. • Breaking Change Detection: Highlights removed endpoints, modified path/query parameters, and schema revisions. • Impact Warning Modal: Alerts developers when stored variables, presets, or workflows may be affected by spec updates. 5. ASSERTIONS & AUTOMATED RESPONSE TESTING • Multi-Condition Rules: Test status codes, execution duration, and response headers. • Deep JSONPath Assertions: Assert on nested JSON response structures (e.g., $.user.email equals expected value). • Regex & Type Validation: Match response strings against regex patterns or enforce numeric ranges. 6. 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): Inspect, search, copy, and create project variables directly over Swagger UI with instant blur auto-save. • Secret Masking: Toggle visibility for sensitive tokens and keys, with one-click {{KEY}} tag copying. • Auto-Extraction Rules: Define rules to automatically parse and save response properties into variables upon execution. • In-Page Variable Resolution: Use {{VARIABLE_NAME}} in URL paths, query parameters, headers, and request bodies. 7. SMART WORKSPACES & PORT RESILIENCE • Modern Card-Based Switcher: View and organize all 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 subt…