skills.rest
bdbch
bdbchCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-surface

Map public interfaces of modules, packages, or systems.

2|Updated May 15, 2026
Search Tags:#code review#system design#module analysis#interface documentation#api mapping
One-click install
npx skills add https://github.com/bdbch/ai-dotfiles --skill api-surface
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-surface
Source: https://github.com/bdbch/ai-dotfiles/tree/main/skills/api-surface
Command: npx skills add https://github.com/bdbch/ai-dotfiles --skill api-surface

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill helps developers quickly understand and document the public interfaces of modules, packages, or systems, aiding in design, migration, and documentation.

Core Features & Use Cases

  • Inventory Creation: Automatically generate a detailed inventory of public exports, endpoints, CLI commands, configuration points, and events.
  • Use Case: When integrating a new library into your project, use this Skill to quickly understand all the public APIs it provides, ensuring compatibility and ease of integration.

Quick Start

Use the api-surface skill to map the public interfaces of the 'express' web framework.

Frequently Asked Questions about api-surface

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I map public interfaces of a module or system for migration?▼

Mapping public interfaces involves analyzing entry points, grepping for exports, inspecting route definitions, and identifying CLI commands, config loading, and event emitting patterns to generate a comprehensive API inventory.

How do I automatically document endpoints and exports for a codebase?▼

Automatically document endpoints and exports by inspecting route definitions and grepping for exports to generate a detailed interface inventory. This identifies public APIs, configuration points, and events for comprehensive documentation.

What is an API surface inventory and when do I need it?▼

An API surface inventory is a comprehensive map of public exports, endpoints, CLI commands, configuration points, and events. You need it during system design, library integration, migration, and documentation processes to ensure compatibility.

Can I use interface mapping to analyze CLI commands and configuration points?▼

Yes, interface mapping analyzes CLI command definitions and config loading patterns alongside exports and endpoints. This identifies all configuration points and commands, aiding in system design, migration, and documentation processes.

What's the best way to understand a new library's public APIs before integration?▼

The best way to understand a new library's public APIs is to map its public interfaces, generating an inventory of exports, endpoints, CLI commands, configuration points, and events to ensure seamless integration and compatibility.

Does mapping public interfaces require analyzing event emitting patterns?▼

Yes, mapping public interfaces requires analyzing event emitting patterns to identify all exposed events. This ensures a comprehensive API inventory that captures exports, endpoints, CLI commands, and configuration points accurately.

Related Skills

Explore More Software Engineering Skills→
vecearvecear

codebase-summarizer

Analyze a repository to generate ARCHITECTURE.md with Mermaid diagrams and entry points.

Community
Advanced
bilibilibilibili
120

carocut-planner-analysis

Extract and catalog video production materials into inventory.yaml and data.json.

Official
Advanced
SeemSeamSeemSeam
17

archi-advice

Generate architecture improvement advice from architecture evidence and source code analysis.

Community
Advanced
Nikolay-ShirokovNikolay-Shirokov
511

form-info

Parse Form.xml files to summarize 1C managed form elements, attributes, events, and commands.

Community
Basic