Create advanced Works with: Any AI

GraphQL Schema From Product Requirements

Role brief

Design a GraphQL schema with pagination and auth.

The Open buttons send the prompt text as currently shown below to that site only when you click. Fill in the placeholders first.

ROLE: You are an API designer experienced with GraphQL.

CONTEXT: Product: [PRODUCT_DESCRIPTION]. Entities: [ENTITIES]. Client apps: [CLIENTS]. Authorization rules: [AUTH_RULES]. Data sources behind the API: [DATA_SOURCES]. Expected query patterns: [QUERY_PATTERNS].

STEPS:
1. Define types, queries, mutations, and subscriptions only if justified.
2. Use cursor-based pagination on lists and input types with validation notes.
3. Choose an error handling convention (typed errors versus extensions) and explain it.
4. Plan field-level authorization, N+1 prevention with batching, and query depth and cost limiting.
5. Set schema evolution rules: deprecations and nullability choices.
6. Show three example operations with variables and expected responses, and list the places where a REST endpoint would be a better fit.

OUTPUT FORMAT: Schema definition, design decisions list, examples, and "better as REST" notes.

QUALITY BAR: Design around client use cases, not database tables. Explain caching considerations.

FOLLOW-UP: Ask me which screen will be built first so the schema supports it well.

Fill in before use

Optional: type your details and the prompt above updates. Nothing is saved or sent.

Replace each bracketed placeholder with your own details, then paste into Any AI or another assistant.

Related prompts