Prompts de tecnología y desarrollo
Genera documentación de API al nivel de Stripe: autenticación, endpoints, errores y webhooks, para que los desarrolladores puedan autenticarse, realizar su primera llamada y gestionar un error en menos de 10 minutos.
Este prompt para generar documentación de API de AI crea documentación alineada con la especificación de OpenAPI: descripción general, guía de autenticación, inicio rápido, referencia de endpoints con ejemplos de código en varios lenguajes, gestión de errores con soluciones, límites de solicitudes, webhooks, SDK, política de versiones y registro de cambios, en el formato que usan los líderes de experiencia del desarrollador. Pégalo en Claude, ChatGPT o cualquier chat de AI, añade la especificación de tu API y obtén documentación lista para Docusaurus, ReadMe, Mintlify o GitBook.
La autenticación es lo primero: un desarrollador que no puede autenticarse se rinde. Cada respuesta de error se documenta con el código de estado, la causa y cómo solucionarlo (los errores silenciosos están prohibidos). Cada endpoint incluye ejemplos completos y realistas de solicitudes y respuestas en varios lenguajes: los valores de marcador de posición como "example_value_1" no son aceptables. Funciona con Claude, ChatGPT o cualquier modelo de chat de AI.
Lo que obtienes
- Un prompt de producción para generar documentación de API de AI (más de 900 palabras)
- Estructura completa de la documentación: descripción general, autenticación, inicio rápido, referencia de endpoints, errores, límites de solicitudes, webhooks, SDK y registro de cambios
- Referencia de endpoints con ejemplos de código en varios lenguajes (cURL, Python, JavaScript, Go, Ruby - elige 3-5)
- Tabla completa de códigos de error: estado, código, causa y cómo resolver cada error
- Personalización para API REST, GraphQL, con muchos webhooks, empresariales/SOAP, de uso interno exclusivo y orientadas a socios
Diseñado para
Desarrolladores backend
Equipos de plataforma
Relaciones con desarrolladores
Arquitectos técnicos
Ingenieros de DX