Browse Categories

API Design

Design RESTful APIs, GraphQL schemas, and API specifications.

10 prompts found

API SDK Generator Design Prompt API Design

API SDK Generator Design Prompt

Design an SDK generation strategy for [API]. Include: OpenAPI spec requirements for auto-generation, supported languages (JavaScript, Python, Go, Java, Ruby),…

August 29, 2026 0
API Testing Strategy Prompt API Design

API Testing Strategy Prompt

Design a testing strategy for [API]. Include: unit tests (service layer), integration tests (database + API), contract tests (Pact), end-to-end…

August 29, 2026 0
API Pagination Design Prompt API Design

API Pagination Design Prompt

Design pagination for [API] endpoints returning collections. Compare: offset/limit, cursor-based, keyset, and page-based. For the recommended approach: provide request format,…

August 29, 2026 0
API Error Handling Design Prompt API Design

API Error Handling Design Prompt

Design a consistent error handling format for [API]. Include: error response structure (error code, message, details, trace ID, documentation link),…

August 29, 2026 0
API Authentication Design Prompt API Design

API Authentication Design Prompt

Design an authentication system for [API]. Compare: API keys, JWT, OAuth 2.0 (authorization code, client credentials, device flow), and session-based.…

August 29, 2026 0
API Rate Limiting Design Prompt API Design

API Rate Limiting Design Prompt

Design a rate limiting strategy for [API]. Include: rate limit algorithms comparison (fixed window, sliding window, token bucket, leaky bucket),…

August 29, 2026 0
Webhook Design Prompt for Event Systems API Design

Webhook Design Prompt for Event Systems

Design a webhook system for [SERVICE]. Include: event types and payloads, webhook registration API, delivery mechanism (retry strategy with exponential…

August 29, 2026 0
API Versioning Strategy Prompt API Design

API Versioning Strategy Prompt

Design an API versioning strategy for [API]. Compare: URI versioning (/v1/), header versioning (Accept header), query parameter (?version=1), and content…

August 29, 2026 0
GraphQL Schema Design Prompt API Design

GraphQL Schema Design Prompt

Design a GraphQL schema for [DOMAIN/APPLICATION]. Include: Query type (field definitions with arguments), Mutation type (create/update/delete operations), Type definitions (objects,…

August 29, 2026 0
RESTful API Design Prompt for New Resources API Design

RESTful API Design Prompt for New Resources

Design a RESTful API for [RESOURCE] in a [APPLICATION TYPE] application. Include: resource model (fields, types, relationships), URL structure (collection,…

August 29, 2026 0