API de Personas — Recurso Profesia

Esta página simula una API ficticia para gestionar personas. Cada bloque representa un endpoint. Edita el body si quieres y pulsa «Enviar» para ver una respuesta simulada.

¿Qué es JSON?

JSON (JavaScript Object Notation) es un formato de texto para intercambiar datos. Usa pares clave: valor, listas entre corchetes [] y objetos entre llaves {}. Las APIs suelen enviar y recibir datos en JSON. Puedes editar el ejemplo de abajo para ver la estructura.

En esta página, todas las peticiones y respuestas de la API usan JSON para representar personas y listas de personas.

JavaScript Object Notation: texto que representa objetos y listas.
Muy usado para comunicar frontend y backend en APIs web.
Las claves van entre comillas dobles y los valores pueden ser número, texto, booleano, objeto u lista.
En una API, el body de una petición y la respuesta suelen ir en JSON.

Ejemplo de JSON (editable)

Paso 1 · GET — Listar todas las personas

El método GET se usa para leer datos sin modificarlos. En este endpoint, la API devuelve la lista completa de personas en formato JSON. No se envía body, solo la URL.

Objetivo: traer todas las personas guardadas en el sistema.
Ruta: /api/personas (sin parámetros, sin body).
Uso típico: pantallas de listado, tablas, dashboards.
Respuesta simulada: código 200 OK y un array personas en JSON.

GET /api/personas

Obtener todas las personas.

Request

Response

Body (JSON)

Paso 2 · GET — Obtener una persona por ID

Aquí también usamos GET, pero añadimos el ID en la URL. La API devuelve solo la persona que coincide con ese ID. Si no existe, responde con un error 404 simulando \"no encontrado\".

Objetivo: consultar el detalle de una sola persona.
Ruta: /api/personas/:id, donde :id es un número (1, 2, 3...).
Uso típico: pantallas de detalle o edición de una ficha.
Respuestas simuladas: 200 OK con la persona encontrada o 404 Not Found si no existe.

GET /api/personas/

Obtener una persona por ID.

Request

Response

Body (JSON)

Paso 3 · POST — Crear una nueva persona

El método POST se utiliza para crear recursos nuevos. Enviamos los datos de la persona en el body como JSON. La API responde normalmente con un código 201 y el recurso creado.

Objetivo: dar de alta una nueva persona en el sistema.
Ruta: /api/personas.
Body: JSON con los campos requeridos (nombre, edad, email, etc.).
Respuesta simulada: 201 Created con la persona creada y un id nuevo.

POST /api/personas

Crear una nueva persona. Body en JSON.

Body (JSON)

Request

Response

Body (JSON)

Paso 4 · PUT — Reemplazar una persona

PUT sirve para reemplazar por completo un recurso existente. Indicamos el ID en la URL y enviamos en el body todos los campos de la persona, incluso los que no cambiaron.

Objetivo: sobrescribir una persona con una nueva versión completa.
Ruta: /api/personas/:id.
Body: JSON con todos los campos de la persona (si omites uno, se perdería).
Diferencia con PATCH: PUT reemplaza todo el recurso; PATCH solo algunos campos.

PUT /api/personas/

Reemplazar una persona por completo. Body con todos los campos.

Body (JSON)

Request

Response

Body (JSON)

Paso 5 · PATCH — Actualizar parcialmente una persona

Con PATCH actualizamos solo algunos campos del recurso. En el body enviamos únicamente las propiedades que queremos modificar (por ejemplo, solo la edad o el email).

Objetivo: modificar uno o varios campos sin tocar el resto.
Ruta: /api/personas/:id.
Body: JSON parcial (por ejemplo solo { "edad": 31 }).
Uso típico: formularios de edición donde el usuario cambia solo algunos datos.

PATCH /api/personas/

Actualizar solo algunos campos de una persona.

Body (JSON) — solo los campos a cambiar

Request

Response

Body (JSON)

Paso 6 · DELETE — Eliminar una persona

El método DELETE se usa para eliminar un recurso. Solo necesitamos el ID en la URL. Normalmente no se envía body y la respuesta suele incluir un mensaje de confirmación.

Objetivo: borrar definitivamente una persona.
Ruta: /api/personas/:id.
Body: en la mayoría de APIs no se envía body en DELETE.
Respuesta simulada: 200 OK con un mensaje de confirmación.

DELETE /api/personas/

Eliminar una persona por ID.

Request

Response

Body (JSON)