Forge de documentación de referencia de API

Esta plantilla de generador de documentación de API convierte definiciones de endpoints, archivos de esquema y notas de implementación en documentación de referencia pulida. Está diseñada para producir descripciones consistentes de endpoints, campos de solicitud y respuesta, notas de autenticación y ejemplos de payloads. La estructura ayuda a los equipos a documentar APIs más rápido, manteniendo el resultado alineado con el contrato real en lugar de texto genérico de relleno.

Es ideal para ingenieros de plataforma, equipos de backend y escritores de developer experience que mantienen APIs públicas o internas. El prompt anima al modelo a listar parámetros requeridos, parámetros opcionales, códigos de estado y errores comunes en un formato que los desarrolladores pueden revisar rápidamente. También admite APIs versionadas, lo cual es útil cuando necesitas documentación separada para v1 y v2 o cuando las desactualizaciones deben señalarse con claridad. Úsala cada vez que cambie un esquema y la documentación deba ponerse al día sin tener que reescribirla manualmente.

Personaliza la plantilla proporcionando {{API_SPEC}}, {{AUTH_METHOD}} y {{TARGET_READERS}}. Agrega {{EXAMPLE_REQUESTS}}, {{ERROR_CODES}} y {{VERSION}} para generar páginas de referencia más completas. El resultado debe ser una guía de API estructurada con tablas de endpoints, ejemplos de solicitudes, ejemplos de respuestas y notas sobre límites de velocidad o casos límite. Para mejores resultados, incluye la URL base exacta y cualquier convención de nombres para que el modelo refleje la forma real de tu API y su terminología.