API Design

advanceddevelopmentMin 32K context

Designs RESTful and GraphQL APIs following contract-first principles. Covers endpoint structure, request/response schemas, error handling, versioning, pagination, authentication, and rate limiting. Produces OpenAPI/Swagger specifications and implementation scaffolding.

api rest graphql openapi architecture design

Use Cases

Designing new REST API endpoints from requirements
Generating OpenAPI specifications
API versioning strategy decisions
Error response standardization
GraphQL schema design with resolvers

Example Prompt

Design a REST API for a task management system.

Requirements:
- CRUD operations for tasks (title, description, status, assignee, due_date)
- Task filtering by status, assignee, and date range
- Pagination with cursor-based navigation
- Proper error responses with problem details (RFC 7807)
- Authentication via Bearer token

Deliverables:
1. Endpoint list with HTTP methods and paths
2. Request/response schemas for each endpoint
3. Error response catalog
4. OpenAPI 3.1 specification
5. Rate limiting recommendations

Recommended Models

claude-opus-4-6 gpt-5 gemini-2-5-pro

Compatible Tools

claude-codecursorgithub-copilotkiroany

Modalities

Input: text

→

Output: code, text

Author

OpenModels Community

@openmodelsrun