OpenParable
Skip to content
← Back to skills

API Inventory Scanner

Development
api-inventory-scanner

API Inventory Scanner is an Agent Skill for development published in the a5c-ai/babysitter repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Discover and document existing API endpoints from code, logs, and traffic analysis

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/a5c-ai/babysitter/blob/HEAD/library/specializations/code-migration-modernization/skills/api-inventory-scanner/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/api-inventory-scanner, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

API Inventory Scanner Skill

Discovers and documents existing API endpoints through code analysis, log inspection, and traffic analysis.

Purpose

Enable API discovery for:

  • Endpoint discovery
  • Request/response format extraction
  • Authentication method detection
  • Rate limit identification
  • Consumer mapping

Capabilities

1. Endpoint Discovery

  • Parse route definitions
  • Analyze controller code
  • Inspect API frameworks
  • Find undocumented endpoints

2. Request/Response Format Extraction

  • Extract request schemas
  • Document response formats
  • Identify query parameters
  • Map headers and cookies

3. Authentication Method Detection

  • Identify auth mechanisms
  • Document token formats
  • Map permission requirements
  • Catalog security schemes

4. Rate Limit Identification

  • Find rate limit configurations
  • Document throttling rules
  • Identify quotas
  • Map limit tiers

5. Consumer Mapping

  • Identify API consumers
  • Track usage patterns
  • Map client dependencies
  • Document integrations

6. Usage Pattern Analysis

  • Analyze access logs
  • Identify hot endpoints
  • Track response times
  • Map error rates

Tool Integrations

ToolPurposeIntegration Method
Swagger InspectorTraffic captureGUI
PostmanCollection buildingAPI
Code parsersRoute extractionCLI
Log analyzersTraffic analysisCLI
APM toolsUsage metricsAPI

Output Schema

{
  "scanId": "string",
  "timestamp": "ISO8601",
  "endpoints": [
    {
      "path": "string",
      "method": "string",
      "description": "string",
      "parameters": [],
      "requestBody": {},
      "responses": {},
      "authentication": "string",
      "rateLimit": {},
      "consumers": [],
      "metrics": {}
    }
  ],
  "summary": {
    "totalEndpoints": "number",
    "documented": "number",
    "undocumented": "number"
  }
}

Integration with Migration Processes

  • api-modernization: API inventory
  • integration-migration: Integration mapping

Related Skills

  • openapi-generator: Spec generation
  • api-compatibility-analyzer: Version analysis

Related Agents

  • api-modernization-architect: API design