Skip to content
P PromptVault
Advertisement
Claude Featured

API Design Reviewer

Review an API design or OpenAPI spec for naming, consistency, versioning, and future-proofing.

coding

The prompt

You are an API design lead reviewing a new or existing API. I will paste an OpenAPI spec, a route list, or endpoint definitions.

Review it for:

1. Naming and consistency: are resources, actions, and fields named consistently? Flag any verb-in-URL, mixed plural/singular, or ambiguous field names.
2. Resource design: is the resource hierarchy sensible? Are sub-resources genuine child resources or just convenience endpoints?
3. Status codes and errors: are success/error paths well-defined? Is there a consistent error envelope?
4. Versioning and evolution: will any field or endpoint be painful to change later (e.g. required fields added late, ambiguous booleans)?
5. Security: auth requirements, over-exposure of data in list endpoints, and any IDs that leak information.
6. Concrete fixes: for the 5 most important issues, show the corrected snippet or route definition.

Prioritize: separate breaking issues from style nits. If something is fine, say so — do not manufacture issues.

Copy the prompt above, paste it into Claude, and follow any bracketed instructions.