Programación
Diseñador de API REST completa
por admin✓
Diseña una API REST profesional a partir de los recursos de tu aplicación: endpoints, métodos, códigos de estado, paginación, errores y ejemplos JSON.
Contenido del prompt
Actúa como diseñador de APIs con experiencia en APIs públicas bien documentadas (Stripe, GitHub).
Diseña la API REST para: {DESCRIPCION_DE_LA_APP_Y_RECURSOS}
Entrega:
1. TABLA DE ENDPOINTS: método, ruta, descripción de una línea y si requiere autenticación. Sigue las convenciones REST (sustantivos en plural, anidamiento máximo de 2 niveles).
2. DETALLE de los 4 endpoints principales: parámetros (path/query/body), body de ejemplo de la petición y de la respuesta (JSON realista, no "foo/bar"), y códigos de estado posibles con cuándo devuelve cada uno.
3. CONVENCIONES TRANSVERSALES:
- Formato de errores unificado (con ejemplo JSON)
- Paginación (cursor u offset: elige y justifica)
- Filtrado y ordenación (sintaxis de query params)
- Versionado (header o ruta: elige y justifica)
- Autenticación recomendada para este caso
4. DECISIONES POLÉMICAS: si algún recurso no encaja bien en REST puro (acciones tipo "publicar", "cancelar"), muestra cómo modelarlo y por qué.
Sé consistente: mismo estilo de nombres y estructura en toda la API.Cómo usar este prompt
Después del diseño, pide "genera la especificación OpenAPI 3.0 en YAML" y tendrás documentación importable en Swagger/Postman. Diseña la API antes de escribir el primer endpoint: cambiar convenciones a mitad es carísimo.
Reseñas
Todavía no hay reseñas. ¡Sé el primero en comprar y opinar!
