api-mapper CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

API Mapper is a Chrome Extension that captures and documents API calls from websites. It adds a panel to Chrome DevTools that monitors network requests and exports them as OpenAPI 3.0 specifications.

Architecture

Core Components

1. Background Script (background.js)

   • Uses Chrome's webRequest API to intercept XHR and Fetch requests
   • Maintains a Map of API endpoints with their captured data
   • Implements memory management to limit stored data
   • Communicates with DevTools panel via Chrome runtime messaging
   • Critical: Must include chrome.runtime.sendMessage() to send updates to panel

2. DevTools Panel (panel.js)

   • Main UI logic displaying captured API calls
   • Implements filtering by host, method, and search text
   • Generates OpenAPI 3.0 specifications from captured data
   • Uses port-based messaging for initial connection and runtime messaging for updates
   • Creates cURL commands with optional complete header capture

3. Security & Configuration (config.js)

   • Contains SecurityUtils object for sanitizing sensitive data
   • Configurable limits for memory management
   • Lists of sensitive headers and parameters to redact

Key Technical Constraints

1. Manifest V3 Limitations

   • Cannot modify request headers in webRequest API
   • Must use host_permissions: ["<all_urls>"] not in permissions array
   • Background script runs as service worker

2. Chrome Extension Messaging

   • Sets cannot be serialized - must convert to Arrays before sending
   • Panel receives updates via both port messages and runtime messages
   • Background script must handle connection/disconnection gracefully

3. OpenAPI Generation

   • Must use valid JSON Schema types only (string, number, boolean, object, array)
   • Use either 'example' OR 'examples' in parameters, never both
   • Path parameters are detected from numeric IDs and UUIDs