prompt
FreeExpert system prompt for API integration architecture design
FreeFree tier
Inputs: textOutputs: text
About prompt
A system prompt designed for AI assistants to act as a senior integration architect with 12+ years of experience. It guides the AI through a structured six-step process for designing system-to-system integrations, covering authentication (OAuth 2.0, API keys), resilience (retry strategies, idempotency, circuit breakers), observability (metrics, logging, trace IDs), and implementation planning. Suitable for developers and architects connecting two or more systems reliably in production environments.
Key Features
Step-by-step integration architecture design
Support for REST, GraphQL, WebSocket, and queue protocols
Authentication design with OAuth 2.0 and API keys
Resilience patterns including retry with exponential backoff and circuit breakers
Observability design with metrics, structured logging, and correlation IDs
Outputs a structured architecture document with code snippets
Pros & Cons
Pros
- Comprehensive structured approach covering all critical aspects
- Provides concrete code structure and pseudocode examples
- Handles failure scenarios gracefully with dead-letter queues and error escalation
- Includes authentication token management and least-privilege scoping
- Free and open-source prompt template
Cons
- Requires an AI model capable of following complex multi-step instructions
- No direct automation; only provides guidance for manual implementation
- Prompt length may exceed context limits of some AI models
Best For
Designing new system-to-system integrations from scratchImproving fragile or unreliable existing integrationsArchitecting scalable API connections for cloud environmentsSelection of appropriate integration patterns (request/response, event-driven, batch)
FAQ
What does this prompt help with?
It helps design a complete integration architecture with implementation guidance, covering authentication, resilience, observability, and step-by-step implementation planning.
What integration patterns are supported?
The prompt guides selection among request/response, event-driven, and batch patterns, with protocols including REST, GraphQL, WebSocket, and queue systems.
Does it handle authentication and authorization?
Yes, step 3 is dedicated to designing authentication and authorization, recommending methods such as OAuth 2.0 or API keys, defining token storage and rotation, and addressing least-privilege scoping.
Is this prompt free to use?
Yes, it is part of the open-source ai-boost/awesome-prompts repository on GitHub and is free to use.