Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/danielcruca/plataformas-abiertas-2026-2c/llms.txt

Use this file to discover all available pages before exploring further.

Durante el curso se construyeron dos APIs REST con Flask: Hola Mundo, una introducción mínima a la creación de endpoints, y API Estudiantes, una práctica que extiende el concepto con distintas formas de recibir parámetros. Esta página documenta todos sus endpoints, incluyendo parámetros esperados, respuestas posibles y URLs de ejemplo.
Asegúrate de que el servidor Flask esté corriendo antes de probar los endpoints. Inicia con python run.py desde la carpeta v1.

API Hola Mundo

Prefijo de todas las rutas: /holamundo-ejemplo/api/v1 Esta API introduce los conceptos básicos: retornar un valor fijo y retornar una respuesta dinámica a partir de parámetros de la query string.

GET /holamundo-ejemplo/api/v1/holamundo

Retorna una cadena de texto simple como respuesta de prueba. No requiere ningún parámetro.
GET http://127.0.0.1:5000/holamundo-ejemplo/api/v1/holamundo
Respuesta exitosa — 200 OK
"hola mundo"

GET /holamundo-ejemplo/api/v1/saludo

Retorna un saludo personalizado construido a partir del nombre y apellido recibidos como parámetros de la query string.
GET http://127.0.0.1:5000/holamundo-ejemplo/api/v1/saludo?nombre=Jose&apellido=Mujica
Parámetros de query string
nombre
string
required
El nombre de la persona a saludar.
apellido
string
required
El apellido de la persona a saludar.
Respuesta exitosa — 200 OK
{
  "saludo": "Hola Jose Mujica"
}
Respuesta de error — 400 (cuando falta alguno de los parámetros requeridos)
{
  "error": "Faltan parámetros nombre o apellido"
}

API Estudiantes

Prefijo de todas las rutas: /estudiante/api/v1 La API Estudiantes es una práctica que consolida el uso de endpoints con distintos métodos de recepción de datos: sin parámetros, con cuerpo JSON y con query string.

GET /estudiante/api/v1/hola

Retorna un mensaje de bienvenida fijo. No requiere ningún parámetro.
GET http://127.0.0.1:5000/estudiante/api/v1/hola
Respuesta exitosa — 200 OK
{
  "message": "Hola estudiante",
  "status": "success"
}

GET /estudiante/api/v1/saludo

Retorna un saludo personalizado para el estudiante, recibiendo los datos desde el cuerpo JSON de la solicitud.
GET http://127.0.0.1:5000/estudiante/api/v1/saludo
Cuerpo de la solicitud (JSON)
nombre
string
required
El nombre del estudiante.
apellido
string
required
El apellido del estudiante.
Ejemplo de cuerpo:
{
  "nombre": "Luis",
  "apellido": "Coto"
}
Respuesta exitosa — 200 OK
{
  "saludo": "Hola estudiante Luis Coto"
}
Respuesta de error — 400 (cuando falta alguno de los campos en el cuerpo de la solicitud)
{
  "error": "Faltan parámetros nombre o apellido"
}

GET /estudiante/api/v1/saludo-parametros

Retorna un saludo personalizado para el estudiante, recibiendo los datos desde la query string de la URL.
GET http://127.0.0.1:5000/estudiante/api/v1/saludo-parametros?nombre=Luis&apellido=Coto
Parámetros de query string
nombre
string
required
El nombre del estudiante.
apellido
string
required
El apellido del estudiante.
Respuesta exitosa — 200 OK
{
  "saludo": "Hola estudiante Luis Coto"
}
Respuesta de error — 400 (cuando falta alguno de los parámetros en la URL)
{
  "error": "Faltan parámetros nombre o apellido"
}

Comparación de métodos de recepción de datos

Sin parámetros

Endpoints como /hola y /holamundo no necesitan ninguna entrada y siempre devuelven la misma respuesta.

Query string

Los parámetros van en la URL después del ?. Ideal para filtros y búsquedas simples. Ejemplo: ?nombre=Luis&apellido=Coto.

Cuerpo JSON

Los datos se envían en el cuerpo de la solicitud como JSON. Más adecuado para datos sensibles o estructuras complejas.

Build docs developers (and LLMs) love