Redactar una descripción de API a partir de rutas existentes

Plantilla que convierte rutas y ejemplos existentes en un borrador OpenAPI con una lista de puntos abiertos. Cópielo en la herramienta de IA que prefiera, que luego redacta el borrador de la descripción de la API.

Tema: Apps y prototipos
Tipo: Plantilla
Nivel: Intermedio
Tiempo: aprox. 15 min

Los resultados dependen de la herramienta, del modelo y de lo que escriba.

Vista previa del resultado

Ejemplo: escrito por nuestra redacción, no es una respuesta real de IA.

paths: /orders/{id}: get: summary: Obtener un pedido responses: "200": { $ref: "#/components/schemas/Order" } "404": { description: Pedido no encontrado } Puntos abiertos: - status: aquí «open», en /orders «pending» - Formato de error de /refunds desconocido

Rellenar

Lo que escriba se queda en esta ventana del navegador. No guardamos ni enviamos nada.

API¿Qué API?

Material¿Qué puede pegar?

Uso¿Para qué es la descripción?

Su prompt

Escriba un borrador OpenAPI para la siguiente API.
API: [API]
Material: [Material]
Uso: [Uso]
Pasos: 1. Lea rutas, métodos, parámetros y respuestas de ejemplo del material. 2. Escriba una entrada por ruta con un resumen breve, parámetros, cuerpo de la solicitud y respuestas, incluidas las de error. 3. Describa una sola vez como componentes las estructuras de datos reutilizables en lugar de repetirlas. 4. Describa la autenticación solo en la medida en que la muestre el material, sin inventar nada. 5. Enumere los puntos abiertos: campos de significado poco claro, rutas que se comportan distinto de rutas similares y descripciones de error que faltan. 6. Marque cada suposición del borrador como comentario.
Resultado: borrador OpenAPI en YAML, lista de puntos abiertos y suposiciones.

Pon especial atención en describir solo lo que muestra el material y marcar cada suposición.

Antes de responder, comprueba: ¿se cumplen todas las indicaciones? Si falta un dato importante o aún queda un marcador entre corchetes, pregunta en lugar de adivinar. Señala las suposiciones como tales.

Escriba un borrador OpenAPI para la siguiente API.
API: [API]
Material: [Material]
Uso: [Uso]
Pasos: 1. Lea rutas, métodos, parámetros y respuestas de ejemplo del material. 2. Escriba una entrada por ruta con un resumen breve, parámetros, cuerpo de la solicitud y respuestas, incluidas las de error. 3. Describa una sola vez como componentes las estructuras de datos reutilizables en lugar de repetirlas. 4. Describa la autenticación solo en la medida en que la muestre el material, sin inventar nada. 5. Enumere los puntos abiertos: campos de significado poco claro, rutas que se comportan distinto de rutas similares y descripciones de error que faltan. 6. Marque cada suposición del borrador como comentario.
Resultado: borrador OpenAPI en YAML, lista de puntos abiertos y suposiciones.

Pon especial atención en describir solo lo que muestra el material y marcar cada suposición.

Antes de responder, comprueba: ¿se cumplen todas las indicaciones? Si falta un dato importante o aún queda un marcador entre corchetes, pregunta en lugar de adivinar. Señala las suposiciones como tales.

Esto es una instrucción para una IA, todavía no el resultado.

Dónde funciona este prompt

Estas herramientas de IA encajan bien con este prompt:

Cómo usarlo

Rellene los campos o toque una sugerencia. No incluya nombres, direcciones ni otros datos personales.
Copie el prompt terminado en la herramienta de IA que prefiera.
Pegue ejemplos con valores inventados; los tokens reales y los datos de clientes no deben ir en el material.

¿Por qué funciona?

Una descripción escrita a partir del código muestra los huecos que nadie nota mientras el código funciona: errores sin documentar, campos con dos significados y rutas que rompen el patrón.

Consejos

Compare el borrador con la API en funcionamiento antes de publicarlo; una descripción que no coincide con la realidad es peor que ninguna.

Puede usar nuestros prompts libremente, también en el trabajo. No las publique como colección propia. No damos garantía sobre los resultados de la IA; revíselos usted. Condiciones de uso

Redactar una descripción de API a partir de rutas existentes

Vista previa del resultado

Rellenar

Su prompt

Dónde funciona este prompt

Cómo usarlo

¿Por qué funciona?

Consejos

También le puede servir

Definir la paginación de una lista de API Nuevo

Escribir una referencia de API útil Nuevo

Planificar un backfill de datos con freno Nuevo