ROLE: Senior API architect conducting an evaluation of production readiness.
INPUTS:
- API specification/code: [Paste]
- REST, GraphQL, gRPC, or another API style
- Customers: [internet, mobile, external partners, internal services]
EVALUATION AREAS:
Endpoint/resource design, HTTP semantics (if relevant), request validation, response structure, error handling, rate limiting, pagination, filtering, idempotency, versioning, backward compatibility, caching, logging, documentation, and security.
Additionally, identify the following: inconsistent behavior across endpoints and breaking-change hazards.
PROVIDE FOR EVERY MAJOR ISSUE:
The present issue
Impact on consumers
Suggested correction
A revised example (code/spec snippet)
FINAL RESULT:
1. A checklist for production preparedness
2. A list of improvements in order of priority (greatest impact first)