IntermedioDocumentaciónAberto

Generador de Documentación API REST Completa con Ejemplos de Código

Crea documentación técnica profesional para APIs REST con endpoints, parámetros, respuestas y ejemplos de código.

programaciondocumentacion

Objetivo del Prompt

Generar documentación técnica completa y profesional que permita a cualquier desarrollador integrar la API sin soporte adicional.

Ejemplo Real de Uso

La startup fintech 'PagosYa' necesita documentar su API de procesamiento de pagos con 15+ endpoints para que equipos de e-commerce puedan integrar su servicio. Requieren documentación clara, ejemplos funcionales y códigos de error.

Prompt

Actúa como un escritor técnico senior especializado en documentación de APIs REST. Tu tarea es generar documentación completa, clara y profesional lista para publicar.

## CONTEXTO DEL PROYECTO
- Nombre de la API: [NOMBRE DE LA API]
- Versión: [VERSIÓN, ej: v2.1]
- Descripción general: [DESCRIPCIÓN DEL PROPÓSITO DE LA API]
- Base URL: [URL BASE, ej: https://api.ejemplo.com]
- Autenticación: [MÉTODO: Bearer Token, API Key, OAuth2, JWT]
- Rate limit: [LÍMITE DE PETICIONES, ej: 1000/hora]

## ENDPOINTS A DOCUMENTAR
Lista todos los endpoints con su información completa:

[METODO] /[RUTA_ENDPOINT]
Descripción: [DESCRIPCIÓN DEL ENDPOINT]
Headers requeridos: [LISTA DE HEADERS]
Parámetros de path: [NOMBRE, TIPO, REQUERIDO, DESCRIPCIÓN]
Parámetros de query: [NOMBRE, TIPO, REQUERIDO, DESCRIPCIÓN, EJEMPLO]
Body de request: [ESTRUCTURA JSON CON CAMPOS]
Respuestas posibles: [CÓDIGO HTTP, DESCRIPCIÓN, ESQUEMA JSON]
Ejemplo de request: [CÓDIGO]
Ejemplo de respuesta: [JSON]

## FORMATO DE SALIDA
Genera la documentación siguiendo esta estructura:

1. **RESUMEN EJECUTIVO**: Descripción general de la API
2. **AUTENTICACIÓN**: Explicación del método con ejemplo de obtención de token
3. **ENDPOINTS POR RECURSO**: Documentación individual de cada endpoint
4. **MODELOS DE DATOS**: Definición de esquemas utilizados
5. **CÓDIGOS DE ERROR**: Lista de códigos HTTP con mensajes descriptivos
6. **EJEMPLOS PRÁCTICOS**: Código funcional en [LENGUAJE PREFERIDO, ej: Python, JavaScript, curl]
7. **NOTAS DE VERSIÓN**: Cambios relevantes si aplica

## REGLAS DE REDACCIÓN
- Usa lenguaje técnico pero accesible
- Prioriza ejemplos de código funcionales sobre explicaciones teóricas
- Incluye tanto casos de éxito como de error
- Añade notas de buenas prácticas
- Especifica formatos de fecha, moneda y zonas horarias si aplica

Responde siguiendo exactamente el formato especificado. Incluye todos los campos marcados con [CORCHETES] reemplazados con la información real proporcionada.

Abrir directamente en una IA (el texto va pre-rellenado):

Cómo usar este prompt

  1. 1Pega el prompt directamente en ChatGPT, Claude, Gemini o cualquier asistente de IA.
  2. 2Personaliza los campos entre corchetes [así] con tu información específica.
  3. 3Para mejores resultados, proporciona contexto adicional sobre tu caso de uso.
  4. 4Combina múltiples prompts en una conversación para resultados más completos.
  5. 5Guarda los prompts que más usas para acceso rápido en el futuro.

Prompts relacionados

Ver todos

Suscríbete a AIClases para desbloquear

Accede a 10.000+ prompts listos para usar en cualquier profesión, además de todos los cursos de la plataforma.

Suscribirse por $10 USD/mes

Cancela cuando quieras. Sin penalidades.