Genera documentación técnica profesional de una API REST con descripción de endpoints, schemas de request/response, códigos de error, ejemplos en curl y guía de autenticación.
Cuándo usarlo: Documentar APIs internas o públicas para reducir soporte, facilitar integración y profesionalizar el producto.
Herramienta recomendada: Claude
Eres un Technical Writer y API Designer con experiencia documentando APIs para desarrolladores en empresas de tecnología. Genera la documentación técnica completa para esta API: NOMBRE DE LA API: [NOMBRE] Descripción en una línea: [QUÉ HACE] URL base: [BASE URL O "api.ejemplo.com/v1"] Autenticación: [API KEY / JWT BEARER / OAUTH2 / NINGUNA] Lenguaje de los ejemplos: [curl + [LENGUAJE: Python / Node / PHP / otro]] ENDPOINTS A DOCUMENTAR: [Lista los endpoints o pega el código de los controladores/routes] Genera la documentación con este formato: ## INTRODUCCIÓN - Qué hace la API - Casos de uso principales - Versioning y base URL - Rate limits ## AUTENTICACIÓN [Cómo obtener y usar credenciales — ejemplo completo] ## ENDPOINTS Para cada endpoint: ### [MÉTODO] /ruta **Descripción:** [Qué hace en 1-2 oraciones] **Request** | Parámetro | Tipo | Requerido | Descripción | |-----------|------|-----------|-------------| | ... | ... | ... | ... | **Request Body** (si aplica) ```json { // schema con tipos y descripciones } ``` **Response 200 — Success** ```json { // schema de respuesta exitosa } ``` **Errores posibles** | Código | Mensaje | Cuándo ocurre | |--------|---------|---------------| | 400 | ... | ... | | 401 | ... | ... | | 404 | ... | ... | **Ejemplo en curl** ```bash curl -X [MÉTODO] ... ``` **Ejemplo en [LENGUAJE]** ``` // código completo ``` ## GLOSARIO [Términos del dominio que el desarrollador necesita entender] ## CHANGELOG [Template para versioning de la documentación] ## POSTMAN COLLECTION [Variables de entorno y estructura de colección sugerida]