Regular Show
Regular Show

Regular Show API – Documentación y Playground

Explora y prueba los endpoints de la API (cargados desde openapi.json), con ejemplos y Try it out integrado. La API es pública, sin autenticación, y responde en JSON. Ideal para practicar consumo de API desde front o backend, esta API esta desarrollada con la idea de poder poner en práctica las habilidades de programación y conocimiento básico de APIs REST.


Todo el contenido esta desarrollado con tal de que no desesperes y puedas disfrutar del proceso de aprendizaje. Basta con leer la documentacion, los tips para poder sacar el maximo provecho de la API y jugar con los ejemplos.


Skips personaje de Regular Show

Así que, si eres un programador novicio o simplemente quieres aprender más sobre el consumo de APIs, te recomiendo no entrar en pánico y desesperarte, tomarte con calma y seguir los pasos de la documentación.

Tecnologías usadas en esta API

Esta API fue desarrollada con un stack moderno y ligero que facilita tanto el despliegue como el consumo:

  • Python 3.11 — lenguaje base del proyecto
  • FastAPI — framework para crear APIs rápidas y tipadas
  • Uvicorn — servidor ASGI que ejecuta la aplicación
  • Pydantic — validación de modelos de datos
  • JSON estructurado — formato de los datos consumibles
  • Render — plataforma de hosting y despliegue

Regular Show API – Guía rápida de uso

Base URL

https://apiregularshow.onrender.com

Formatos de ID

Recurso Prefijo Ejemplo Notas
Personajes CHARCT CHARCT001 IDs alfanuméricos, 3 dígitos con cero a la izquierda
Capítulos CAP CAP001 Incluye temporada, número, sinopsis e imdb_score
Temporadas TEMP TEMP01 Devuelve también numero_capitulos y promedio_imdb
Cómics COMC COMC001 Campos: autores, ilustradores, tipo, publicación…

Parámetros comunes

?limit=<n>
Cuántos ítems devolver (útil para paginar).
?skip=<n>
Cuántos ítems omitir desde el inicio (siguiente página).
Tip: para recorrer páginas usa ?limit=20&skip=0, luego ?limit=20&skip=20, etc.

Endpoints por recurso

Personajes

  • GET /personajes — lista paginada.
  • GET /personajes/{id} — detalle por ID (p.ej. CHARCT001).
  • GET /personajes/principales — elenco principal.
  • GET /personajes/aleatorio/{n}n personajes aleatorios.

Capítulos

  • GET /capitulos — lista (campos: id, titulo, numero, temporada, fecha_estreno, imdb_score, sinopsis, imagen_url…)
  • GET /capitulos/{id} — detalle por ID (p.ej. CAP001).

Temporadas

  • GET /temporadas — lista con agregados numero_capitulos y promedio_imdb.
  • GET /temporadas/{id} — detalle por ID (p.ej. TEMP01), con lista de capitulos por ID.

Cómics

  • GET /comics — lista paginada (campos: id, titulo, tipo, numero_issues, autores, ilustradores, publicacion…)
  • GET /comics/{id} — detalle por ID (p.ej. COMC001).

Recomendaciones de uso

  • Para listas largas (ej. capítulos), usa ?limit + ?skip para paginar.
  • El campo imagen_url es externo: respeta el cache del navegador y evita solicitar la misma imagen muchas veces en poco tiempo.
  • Si tu cliente es público, enlaza a esta Wiki para crédito y contexto del proyecto.
  • Para demos, combina /personajes/aleatorio/{n} con tarjetas visuales; y grafica promedio_imdb por temporada.

Errores y validación

404
Recurso no encontrado (ID inexistente).
422
Validación de parámetros (p.ej., tipos incorrectos).
500
Error interno.

Las respuestas de error salen en JSON con mensaje y, en validación, detalles de campos.

Documentación Interactiva de la API

Reporte de errores y avisos

Para los avisos de cualquier error o problema, por favor utiliza el canal de soporte correspondiente indicado en el repositorio de GitHub de este mismo proyecto. Puedes reportar errores, sugerir mejoras o simplemente comentar sobre el uso de la API.

Código animado

Recuerda: No dudes en pedir ayuda si la necesitas.

A continuación el repositorio de GitHub para las consultas generales:
https://github.com/KPBaldur/ApiRegularShow