← Lumbre

Desarrollo de Software con IA Diseñar tus propios endpoints: una API para tu aplicación

Portada de Diseñar tus propios endpoints: una API para tu aplicación

Diseñar tus propios endpoints: una API para tu aplicación

✦ Antes de pedir que la IA construya tu backend, diseña su API: la lista de operaciones que ofrecerá, cada una con verbo, ruta, qué recibe y qué devuelve · Desarrollo de Software con IA · en 7 minutos

Roadwise Consulting

Contenido modificado tras su publicación

Objetivo: Definir una tabla de endpoints (verbo, ruta, entrada, salida) y pedirla a la IA como contrato.

7 min Desarrollo de Software con IA 15–99 años
Modo PPTX
Más
Diseñar tus propios endpoints: una API para tu aplicación

Herramientas de la lección

Sorpréndeme

Sobre este contenido

Ir a

Volver a Módulo 9 · APIs: el pegamento digital Cursos Explorar Mi cuenta Salir del modo estudio

Tu app también es una API para su propio frontend

Consumir APIs ajenas (módulo anterior) y diseñar la tuya son la misma cara de dos monedas. Tu backend expone endpoints que tu propio frontend llama. Si diseñas esa lista con orden —verbos claros, rutas coherentes, entradas y salidas definidas—, la IA construye un sistema que se entiende a sí mismo.

El verbo importa

GET lee, POST crea, PUT cambia, DELETE borra: la convención que hace tu API predecible.
VerboPara qué se usaEjemplo
GETLeer / consultar datos (no cambia nada)GET /contactos
POSTCrear un recurso nuevoPOST /contactos
PUTActualizar / reemplazar uno existentePUT /contactos/{id}
DELETEEliminar un recursoDELETE /contactos/{id}

Diseña la API en una tabla

Esta tabla ES tu API. La pegas en el prompt y la IA no tiene que inventar ni una ruta.
OperaciónVerbo y rutaEntraSale
ListarGET /contactosfiltro opcional por nombrelista de contactos + total
CrearPOST /contactosnombre, teléfono, emailcontacto creado con su id
Ver unoGET /contactos/{id}—el contacto o 404
EditarPUT /contactos/{id}campos a cambiarcontacto actualizado
BorrarDELETE /contactos/{id}—confirmación de borrado

Para reforzar verbos y JSON

Prompt de diseño

Del plano al código en dos pasos

texto
Diseña e implementa la API de Contactos segun esta tabla (respeta verbos y rutas, no inventes otras):\n- GET /contactos?nombre= -> lista + total; solo los del usuario autenticado\n- POST /contactos {nombre*, telefono, email} -> 201 con id; 400 si falta nombre\n- GET /contactos/{id} -> contacto o 404\n- PUT /contactos/{id} {campos} -> actualizado o 404\n- DELETE /contactos/{id} -> 204 al borrar\n\nDevuelve primero la documentacion de la API (una tabla igual a esta con sus codigos de estado) y luego el codigo de cada endpoint.
Pedir primero la documentación obliga a la IA (y a ti) a cerrar el diseño antes de escribir código.

Prueba

¿Qué verbo y código de estado tienen más sentido para crear un contacto con éxito?

Rutas como /obtenerContactos y /borrarContacto son tan válidas como GET /contactos y DELETE /contactos/{id}.

Detecta el diseño inconsistente

Revisas el diseño de API de una IA. Señala la incoherencia que la volverá difícil de usar:

Marca la línea o las líneas con error y pulsa Comprobar.

Escribe la tabla de endpoints de una entidad de tu proyecto (5 filas: listar, crear, ver, editar, borrar) con verbo, ruta, entra y sale. Pídele a la IA primero la documentación y después el código.

Si tu API es predecible, tu frontend se escribe casi solo.

Tu texto se guarda sólo en este dispositivo.

Las respuestas y tu progreso se guardan sólo en este dispositivo. Contenido firmado por su autoría mediante Lumbre.
Más sobre esta lección

Comentarios

Inicia sesión para comentar.

Todavía no hay comentarios. Sé la primera persona en opinar.