api-flow

Community

Document API call flows across Hexagonal layers.

Authorryu-qqq
Version1.0.0
Installs0

System Documentation

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.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: api-flow
Download link: https://github.com/ryu-qqq/conventionHub/archive/main.zip#api-flow

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.