Prompt · Developer Tools

API Contract Design

Designs a clean REST or GraphQL contract for a feature before you write code.

Have ready: Describe the feature, your data model, and REST vs GraphQL preference

Fill in · 4 fields

DESCRIBE THE FEATUREPASTE RELEVANT SCHEMAS/TYPES OR "GREENFIELD"REST / GraphQLHOW CLIENTS AUTHENTICATE

Your prompt

Design the API contract for this feature. Ask me nothing, make reasonable assumptions and flag them.

Feature: [DESCRIBE THE FEATURE]
Existing data model: [PASTE RELEVANT SCHEMAS/TYPES OR "GREENFIELD"]
Style: [REST / GraphQL]
Auth: [HOW CLIENTS AUTHENTICATE]

Deliver:
1. Endpoints/operations with method, path, request shape, response shape, and status codes (REST) or types/queries/mutations (GraphQL).
2. Pagination, filtering, and sorting conventions.
3. Error response format with 3 example errors.
4. Idempotency and versioning strategy.
5. Three design decisions you made that I am most likely to regret, and the alternative for each.

Keep resource naming consistent and the surface minimal, prefer fewer, well-designed endpoints over completeness.

Paste it into Muse or any assistant. Blank fields stay as [brackets].

More like this

Commit Message Writer