umlforge_api_sequence
Diagram how services call each other for a user action, including failure paths, retries, and error handling.
Instructions
Diagram how services call each other for a specific user action or API flow.
USE THIS WHEN:
You want to trace a request across multiple services (e.g. "user logs in")
You are designing API contracts between microservices
You need to show failure paths, retries, and error handling between services
You are writing QA test cases or doing incident post-mortems
NOT FOR:
Full codebase analysis → use umlforge_reverse_engineer
Async/event-driven messaging → use umlforge_event_driven
Frontend component interactions → use umlforge_frontend_components
Database schema design → use umlforge_erd_schema
Produces:
Sequence diagram: happy path + at least 2 failure paths, activation boxes, sync vs async arrows, performance boundary annotations
Inter-service dependency table: caller, callee, protocol, failure mode, mitigation
(report_mode=True) Design Score: Resilience, Performance, Contract Clarity (A–F)
Args: services: All participants, e.g. "API Gateway, Auth Service, Order Service, Payment Provider, User DB". user_journey: The action to diagram in plain English, e.g. "User places an order through checkout". report_mode: True → also produce a Design Score report. Pro/Team/Enterprise only.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| services | Yes | ||
| report_mode | No | ||
| user_journey | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |