api-flow

Trace API call flows across Hexagonal layers and generate Markdown documentation.

Updated Aug 23, 2026

Search Tags:#documentation #trace #end-to-end #hexagonal #integration-testing #api-flow

Ready to run

npx skills add https://github.com/ryu-qqq/conventionHub --skill api-flow

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-flow
Source: https://github.com/ryu-qqq/conventionHub/tree/main/.claude/skills/api-flow
Command: npx skills add https://github.com/ryu-qqq/conventionHub --skill api-flow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Tracking and documenting the end-to-end flow of API endpoints across Hexagonal layers to improve traceability and testability.

Core Features & Use Cases

End-to-end flow tracing: Map calls from API router to domain, application, and infrastructure layers.
Documentation generation: Produce hexagonal-layer flow diagrams and md docs for each endpoint.
Use Case: Ensure all HTTP requests for admin controllers are consistently represented across layers during integration tests.

Quick Start

Run the api-flow tool to analyze a single endpoint like /api-flow admin:SellerQueryController.searchSellers and generate the corresponding hexagonal-flow docs.

Frequently Asked Questions about api-flow

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

FAQPage Schema

How do I trace and document API call flows across Hexagonal architecture layers?▼

To trace API call flows across Hexagonal architecture, you can automate mapping calls from API routers through domain, application, and infrastructure layers to generate Markdown documentation with flow diagrams.

What's the best way to generate per-endpoint flow documentation for integration testing pipelines?▼

Generating per-endpoint flow documentation for integration testing pipelines is done by analyzing specific endpoints like admin controllers to produce hexagonal-layer Markdown documents under designated output directories.

Can I document HTTP request flows for admin controllers to verify consistency across layers?▼

Yes, you can document HTTP request flows for admin controllers by mapping the end-to-end trace from the API router to the infrastructure layer, ensuring all requests are consistently represented during integration tests.

How do I create hexagonal-layer flow diagrams for specific API endpoints?▼

You create hexagonal-layer flow diagrams for specific API endpoints by running an analysis tool that traces calls from the entry router to domain and infrastructure layers, outputting Markdown documents for each endpoint.

Do I need an existing API endpoints analysis to generate accurate hexagonal flow documentation?▼

Yes, generating accurate hexagonal flow documentation relies on an existing /api-endpoints analysis to trace the end-to-end call paths and produce correct flow diagrams for your modules.