Architecture Diagram Description

Who it's for

• Blind or visually impaired engineers
• Engineering team leads who need to communicate complex systems
• DevOps engineers who require detailed system descriptions
• Technical writers who create documentation for engineering teams

Use cases

• Rebuilding a system from a lost architecture diagram
• Communicating complex system designs to stakeholders
• Creating documentation for engineering teams with diverse abilities
• Describing system architecture to new team members
• Recreating a system after a disaster recovery scenario

FAQ

Sample output

Components:
- API Gateway: Handles incoming HTTP requests and routes them to the Payments API.
- Auth: Verifies JSON Web Tokens (JWT) for authentication.
- Payments API: Processes payment requests and interacts with the database.
- Redis: Stores idempotency tokens to prevent duplicate transactions.
- Postgres: Persists payment data and transaction history.
- Stripe webhook: Sends notifications of payment events from Stripe.
- Webhook Receiver: Listens for and processes incoming webhook notifications from Stripe.

Connections:
- API Gateway talks to Auth using HTTP.
- Auth talks to Payments API using HTTP.
- Payments API talks to Redis using Redis protocol.
- Payments API talks to Postgres using PostgreSQL protocol.
- Stripe webhook talks to Webhook Receiver using HTTP.
- Webhook Receiver talks to Payments API using HTTP.

Data flow:
1. The client sends a payment request to the API Gateway.
2. The API Gateway forwards the request to Auth for authentication.
3. Auth verifies the JWT and sends the authenticated request to the Payments API.
4. The Payments API checks Redis for an idempotency token to prevent duplicate transactions.
5. If the token is not found, the Payments API generates a new token and stores it in Redis.
6. The Payments API then processes the payment request and stores the transaction data in Postgres.
7. For payment events from Stripe, the Stripe webhook sends a notification to the Webhook Receiver.
8. The Webhook Receiver processes the notification and sends it to the Payments API.
9. The Payments API updates the transaction status in Postgres based on the notification.
10. The Payments API returns a response to the client through the API Gateway.

What's notable:
* The system uses Redis for idempotency to prevent duplicate transactions.
* The Payments API interacts directly with Postgres for writes, but uses a cache for reads is not mentioned, only Redis is used for idempotency.
* The system receives webhook notifications from Stripe to update transaction status.