API Design Review — REST & GraphQL Architecture Audit Prompts

APIs That Developers Actually Want to Use

What's Inside

• Endpoint Design Reviewer — Audits REST endpoints for naming, HTTP method, and resource hierarchy violations
• Versioning Strategy Advisor — Compares URL, header, and query param versioning with migration plan
• Error Response Standardizer — Creates consistent error format with RFC 7807 problem details
• Pagination Pattern Selector — Recommends offset, cursor, or keyset pagination based on use case
• Rate Limiting Designer — Creates tiered rate limit strategy with token bucket configuration
• + 5 more: OpenAPI spec generator, authentication flow reviewer, webhook design, GraphQL schema optimizer, API documentation writer