CodingFree→ Claude / ChatGPT
REST API Design Reviewer
Review an API for consistency, safety, versioning and developer experience.
What you get: A review of endpoints, errors, auth, pagination and a proposed OpenAPI fragment.
Review the API design below for {{product}}. Consumers: {{consumers}}.
Endpoints / spec:
{{api_spec}}
Assess: resource naming and consistency; HTTP verbs and status codes; error format (a single predictable shape with machine-readable codes); pagination, filtering and sorting; idempotency for unsafe operations; authentication and authorization (scopes, object-level access checks); rate limiting; versioning and deprecation strategy; webhooks and async operations; backwards-compatibility risks. Give a prioritized list of changes with before/after examples and an OpenAPI fragment for the most important fix.