API Design

AvanzadaDesarrolloContexto mínimo: 32K

Diseña API RESTful y GraphQL siguiendo principios de contrato primero. Abarca la estructura de endpoints, los esquemas de solicitudes y respuestas, la gestión de errores, el versionado, la paginación, la autenticación y los límites de uso. Produce especificaciones OpenAPI/Swagger y scaffolding de implementación.

Esta descripción se ha traducido automáticamente y todavía no ha sido revisada.

Casos de uso

  • Diseño de nuevos endpoints REST a partir de requisitos
  • Generación de especificaciones OpenAPI
  • Decisiones sobre la estrategia de versionado de API
  • Estandarización de respuestas de error
  • Diseño de esquemas GraphQL con resolvers

Prompt de ejemplo

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

Modelos recomendados

Herramientas compatibles

claude-codecursorgithub-copilotkiroany

Modalidades

Entrada: text
Salida: code, text

Skills relacionadas

Autor

OpenModels Community

@openmodelsrun