#277 Programacion Básico Público v1 ChatGPT, Claude, Swagger #api #documentacion #endpoints #developers

Documentar API

Documentar APIs REST, integraciones o servicios internos.

Volver a biblioteca
🤖
Modelo probado
ChatGPT, Claude, Swagger
📊
Dificultad
Básico
🔖
Versión
v1
📅
Creado
20/05/2026
Revisado
20/05/2026
⏱️
Tiempo estimado
15 min
🔑
Acceso
Público
Recomendación
🎯

Para qué sirve

Documentar APIs REST, integraciones o servicios internos.

📌

Cuándo usarlo

Cuando se necesita documentación técnica entendible y reutilizable.

📥

Datos de entrada necesarios

Lista de endpoints, contratos o ejemplos de llamadas.

📤

Resultado esperado

Documentación de API estructurada y lista para revisar.

💡

Ejemplo de uso

Endpoints: GET /clientes, POST /clientes.

🔧

Consejos para mejorarlo

Ajustar placeholders, tono, extensión y formato al caso real antes de ejecutar el prompt.

📝

Nota del curador

Prompt normalizado para hacerlo más claro, reutilizable y seguro sin cambiar su intención funcional.

⚠️

Restricciones

No inventar datos; indicar los supuestos; adaptar el resultado al contexto real; revisar la salida antes de usarla. No ejecutar ni desplegar código sin pruebas; revisar seguridad, dependencias y compatibilidad.

Prompt completo

Actúa como technical writer especializado en APIs. Crea documentación completa para esta API: {ENDPOINTS} Incluye: 1. Descripción general. 2. Autenticación, si aplica. 3. Endpoints con método, ruta y propósito. 4. Parámetros de entrada. 5. Ejemplos de request y response. 6. Códigos de error y causas probables. 7. Casos de uso habituales. Usa un formato claro y consistente, apto para desarrolladores.

Personalizar prompt

Completa los valores de las variables para generar un prompt personalizado.

Prompt personalizado

Actúa como technical writer especializado en APIs. Crea documentación completa para esta API: {ENDPOINTS} Incluye: 1. Descripción general. 2. Autenticación, si aplica. 3. Endpoints con método, ruta y propósito. 4. Parámetros de entrada. 5. Ejemplos de request y response. 6. Códigos de error y causas probables. 7. Casos de uso habituales. Usa un formato claro y consistente, apto para desarrolladores.