Carga Dorian en Claude y obtén un agente sénior de documentación de API que transforma el código, las rutas o las notas técnicas de tu API en documentación completa y profesional: referencias de endpoints, guías de autenticación, ejemplos de solicitudes y respuestas, tablas de códigos de error y una guía de inicio rápido para desarrolladores, lista para publicar.
La mayoría de las API se documentan al final, mal o nunca, lo que significa que los desarrolladores pierden horas intentando averiguar lo que el código debería haber explicado en minutos. Dorian lo soluciona. Trabaja con lo que tengas: rutas sin procesar, código de controladores, colecciones de Postman o notas preliminares; hace preguntas específicas sobre la API y su audiencia y, después, produce documentación que los desarrolladores pueden usar desde el primer día. Funciona con Claude, ChatGPT o cualquier modelo de chat de AI que acepte prompts del sistema.
Lo que obtienes
-
→
Referencia completa de endpoints - cada endpoint documentado con el método HTTP, la ruta, la descripción, una tabla de parámetros, el cuerpo de la solicitud, la respuesta correcta y los códigos de error, para que los desarrolladores tengan todo lo que necesitan sin leer el código fuente
-
→
Guía de autenticación - método de autenticación documentado con instrucciones para obtener las credenciales, incluirlas en las solicitudes mediante ejemplos del formato de los encabezados y un ejemplo completo de una solicitud autenticada, para que los desarrolladores puedan empezar en minutos, no en horas
-
→
Ejemplos realistas de solicitudes y respuestas - ejemplos de curl y cuerpos JSON con valores realistas para cada endpoint, no cadenas de texto de ejemplo, para que los desarrolladores puedan copiar, pegar y ejecutar de inmediato
-
→
Referencia de códigos de error - tabla completa de errores que cubre cada código de estado que devuelve la API, con descripciones y orientación para resolverlos, para que los desarrolladores puedan gestionar los errores sin abrir un ticket de soporte
-
→
Guía de inicio rápido para desarrolladores - instrucciones paso a paso desde cero hasta la primera llamada de API exitosa en menos de 10 minutos, la sección de mayor valor para cualquier desarrollador que comience una integración
-
→
Flexibilidad de formato - genera la salida en Markdown para GitHub o sitios de documentación, en YAML de OpenAPI 3.0 para Swagger UI o Redoc, o en texto estructurado simple para Confluence y Notion, según el formato que use tu equipo