OpenAPI Companion bởi pratyanj

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, or losing request parameters?

OpenAPI Companion integrates into Swagger UI via Chrome's native Side Panel, giving you a persistent workspace directly inside your API documentation.

─────────────────────────────────────────
CORE FEATURES
─────────────────────────────────────────

1. PERSISTENT AUTHENTICATION
   • Retain authorization across page reloads without re-entering credentials.
   • Supports Bearer tokens, JSON Web Tokens, API Keys, and Basic Authentication.
   • Optional automatic token refresh to keep sessions active while testing.
   • Easily switch between different saved test accounts in a single click.
2. 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.
   • Organize presets with tags and custom notes.
3. MOCK DATA & DATASET STUDIO
   • Over 60 realistic built-in generators for names, emails, addresses, coordinates, test cards, dates, and identifiers.
   • Schema-Aware Synthesis: Automatically generates request bodies matching your endpoint's schema across four modes:
4. Realistic: Production-like sample data.
5. Minimal: Generates only required fields.
6. Boundary: Tests maximum, minimum, and edge-case values.
7. QA & Security: Tests input handling with injection patterns and special character sets.
   • Bulk Dataset Generator: Create multi-row test datasets and export them directly as JSON or CSV files.
   • Live Fill: Auto-detects input fields in the open endpoint and fills empty parameters instantly.
8. REQUEST HISTORY & INSPECTION
   • Automatically records executed API calls with timestamps, status codes, response durations, and payloads.
   • Search and filter past calls by status code to review or replay earlier requests.
9. 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.
   • Bookmark important endpoints for quick access.
10. CODE SNIPPET EXPORT
    • Convert any endpoint or historical request into ready-to-use client code snippets with a single click.

─────────────────────────────────────────
PRIVACY & SECURITY
─────────────────────────────────────────
• 100% Local: All credentials, history, and presets are stored strictly on your local machine.
• No External Tracking: The extension does not connect to external servers or transmit telemetry.
• Non-Intrusive: Functions alongside your existing documentation without modifying backend services.

─────────────────────────────────────────
HOW TO GET STARTED
─────────────────────────────────────────
1. Install OpenAPI Companion.
2. Navigate to any Swagger UI or OpenAPI documentation page.
3. Press Ctrl+Shift+O (or Cmd+Shift+O on Mac) or click the extension icon to open the side panel.
4. Test and manage your API requests seamlessly.