api-design

name	api-design
description	REST/JSON API consistency: resources, errors, pagination.

API Design

Rules

• Noun resources; HTTP verbs correct; stable status codes.
• Error envelope: { "error": { "code", "message", "details?" } }.
• Pagination: cursor preferred; limit capped.
• Auth scheme documented; least privilege.
• Versioning strategy explicit (URL or header).

Done criteria

• Happy + error examples
• Idempotency noted for unsafe retries