Programming & Dev
Intermediate
API Architecture Principles
Consistent API specifications prevent architectural drift and ease integration. This designer prompt uses OpenAPI (Swagger) specifications to establish clean resource pathways, payload structures, and error handlers before you begin coding.
How to Run it
Detail the service you are designing (e.g., a multi-tenant booking system, invoicing agent, or chat microservice).
Optimization Tips
- Idempotency keys: For write endpoints (POST/PUT), ask the AI to include headers for idempotency (
Idempotency-Key) to prevent double-charging or duplicate entries. - Rate Limiting Headers: Define rate limiting response headers (
X-RateLimit-Limit,X-RateLimit-Remaining) in the specifications.
Customize Prompt Parameters
AI Prompt Blueprint
Act as a Lead Backend API Architect. Propose a complete RESTful API design path and OpenAPI 3.0 schema specs (YAML format) representing the resource model: [Insert Resource Model/Service, e.g., E-commerce Cart System]. Your design must detail: 1. All necessary endpoints (GET, POST, PUT, DELETE) adhering to RESTful naming conventions. 2. Explicit HTTP status codes (200, 201, 400, 401, 403, 404, 422, 500) and exact error payload schemas. 3. Query parameter standards for pagination, filtering, and sorting. 4. Request and response JSON body schemas with validation constraints.