analyzing-api-layer

Analyze REST/GraphQL API layers and generate machine-readable docs under docs/unwind/layers/api.

9|Updated Jan 15, 2026

Search Tags:#documentation #api #openapi #graphql #contracts #analyze #layer

Ready to run

npx skills add https://github.com/cliftonc/unwind --skill analyzing-api-layer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: analyzing-api-layer
Source: https://github.com/cliftonc/unwind/tree/main/skills/analyzing-api-layer
Command: npx skills add https://github.com/cliftonc/unwind --skill analyzing-api-layer

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates extracting and documenting an API layer from a codebase to produce consistent, machine-readable documentation and ensure contract preservation.

Core Features & Use Cases

Generate an index and per-domain API docs (endpoints, auth, contracts, errors) under docs/unwind/layers/api.
Preserve and surface external API specifications (OpenAPI/AsyncAPI/TSRest) as authoritative sources for migrations.
Support incremental writes and structured outputs to enable gradual documentation updates.

Quick Start

Scan the repository and generate a complete API-layer documentation set under docs/unwind/layers/api.

Frequently Asked Questions about analyzing-api-layer

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

FAQPage Schema

How do I generate API documentation from my existing codebase?▼

To generate API documentation, this Skill scans your repository to extract endpoints, contracts, auth configurations, and error patterns, writing authoritative machine-readable docs under docs/unwind/layers/api.

Can I preserve external OpenAPI and GraphQL specifications during a codebase migration?▼

Yes, you can preserve external OpenAPI and GraphQL specifications during migrations by surfacing them as authoritative sources, ensuring your API contracts remain intact and accurately documented.

How do I document REST and GraphQL API contracts incrementally?▼

You can document REST and GraphQL API contracts incrementally because the Skill supports structured outputs and incremental writes, enabling gradual documentation updates across multiple file types.

What is the best way to extract API auth configurations and error patterns?▼

The best way to extract API auth configurations and error patterns is to analyze the API layer directly, which pulls these elements from the codebase to produce a complete per-domain documentation set.

Does this API layer analysis tool work with AsyncAPI and TSRest contracts?▼

Yes, the API layer analysis tool works with AsyncAPI and TSRest contracts by preserving and surfacing these external API specifications as authoritative sources within your documentation.