api-flow

Analyze Go API endpoint execution flows and generate Mermaid and ASCII diagrams.

31|4|Updated Aug 24, 2021
One-click install
npx skills add https://github.com/razorpay/trino-gateway --skill api-flow-razorpay
Or copy as Structured Prompt for Agent▌
Please help me install this Agent Skill.
Skill: api-flow
Source: https://github.com/razorpay/trino-gateway/tree/main/.agents/skills/api-flow
Command: npx skills add https://github.com/razorpay/trino-gateway --skill api-flow-razorpay

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyzes Go API endpoints to generate comprehensive flow visualizations in both Mermaid charts and ASCII diagrams, enabling quick understanding of how a request traverses handlers, middleware, services, databases, external APIs, caches, and queues.

Core Features & Use Cases

  • Mermaid charts provide a high-level overview of API execution paths.
  • ASCII diagrams supply a detailed, file-and-line navigable view of the flow, including middleware, handlers, services, and data stores.
  • Use cases include tracing an endpoint, debugging request flows, and documenting complex interactions in Go services.

Quick Start

Provide the endpoint path and repository location to visualize, and I will generate Mermaid and ASCII diagrams.

Frequently Asked Questions about api-flow

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

FAQPage Schema
How do I visualize an API request flow in a Go codebase?▌

Visualize a Go API request flow by providing the endpoint path and repository location to generate Mermaid and ASCII diagrams. These diagrams trace execution paths across handlers, middleware, services, databases, and external HTTP calls.

What is the difference between the Mermaid and ASCII diagrams for Go API tracing?▌

Mermaid diagrams provide a high-level overview of the API execution path, while ASCII diagrams supply a detailed, file-and-line navigable view of the request flow. Both representations map middleware, handlers, services, and data stores.

Can I trace Go API endpoints that interact with queues and caches?▌

Yes, you can trace Go API endpoints that interact with queues and caches. The visualization scales across handlers, middleware, services, databases, external HTTP calls, caches, and queues to map the complete end-to-end execution flow.

Does this API flow visualization support route discovery in Go services?▌

Yes, this API flow visualization supports route discovery in Go services. It analyzes endpoints to discover routes and trace components, generating navigable file-line references for detailed debugging and documentation of complex interactions.

How do I document complex interactions in Go services using flow diagrams?▌

Document complex interactions in Go services by generating flow diagrams that trace how requests traverse handlers, middleware, services, databases, external APIs, caches, and queues. Provide the endpoint path and repository to output Mermaid and ASCII representations.