inventorying-api-surface

Analyze codebases to document public interfaces and REST/GraphQL endpoints.

1|1|Updated Apr 7, 2026
One-click install
npx skills add https://github.com/quangphu1912/codebase-analyzer --skill inventorying-api-surface
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: inventorying-api-surface
Source: https://github.com/quangphu1912/codebase-analyzer/tree/main/skills/inventorying-api-surface
Command: npx skills add https://github.com/quangphu1912/codebase-analyzer --skill inventorying-api-surface

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill unit addresses the challenge of documenting, analyzing, and understanding the public interfaces and implicit APIs exposed by a codebase.

Core Features & Use Cases

  • Comprehensive Documentation: Catalogs public interfaces, REST/GraphQL endpoints, and their contracts.
  • Implicit Entry Points Detection: Finds entry points that aren't exposed through HTTP, like IPC channels and CLI argument schemas.
  • API-to-Data-Flow Mapping: Traces API endpoints to data mutations or queries, ensuring every endpoint has a purpose.
  • Security Signal Identification: Flags undocumented endpoints, security misconfigurations, and more.

Quick Start

Start the inventorying-api-surface skill with the command: /codebase-analyzer inventory-api-surface

Frequently Asked Questions about inventorying-api-surface

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

FAQPage Schema
How do I document an API surface for a codebase I am auditing?

To document an API surface, you can analyze the codebase to catalog public interfaces and REST/GraphQL endpoints. This process maps API-to-data flows, detects implicit entry points like IPC channels, and identifies security signals for comprehensive auditing.

What is the best way to find undocumented API endpoints during security auditing?

Finding undocumented API endpoints during security auditing involves analyzing implicit entry points and mapping API-to-data flows. This process flags security misconfigurations and undocumented endpoints to ensure every interface has a defined purpose and contract.

How do I trace API endpoints to data mutations in my codebase?

Tracing API endpoints to data mutations requires API-to-data-flow mapping. By analyzing the API surface, you connect endpoints directly to their underlying data queries and mutations, verifying that every exposed interface executes a tracked operation.

Can I detect non-HTTP entry points like IPC channels and CLI schemas in a codebase analysis?

Yes, you can detect non-HTTP entry points by analyzing implicit APIs within the codebase. This process identifies IPC channels and CLI argument schemas, expanding your security auditing beyond standard REST or GraphQL interfaces.

Does this codebase analysis work for mapping REST and GraphQL endpoint contracts?

Yes, codebase analysis works for mapping REST and GraphQL endpoint contracts by comprehensively documenting exposed public interfaces. It catalogs the specific agreements and structures defining how clients interact with your API surface.

Why should I map implicit APIs alongside public interfaces for security auditing?

Mapping implicit APIs alongside public interfaces is crucial for security auditing because it exposes hidden entry points like IPC channels. Detecting these undocumented pathways prevents security misconfigurations and ensures complete surface coverage.