Minilección · Español

Cómo mostrar datos de una API externa en tu sitio web

Usa la página de consulta de repositorios lista, añade un resultado útil con el asistente y comprueba respuestas normales, ausentes y no disponibles.

Comenzar la lección interactivaLeer los apuntes

¿Para quién es esta lección?

Para quienes quieren información actual de otro servicio en un sitio. La página y el asistente gestionan el código del navegador; tú puedes centrarte en el resultado.

Antes de empezar

El taller, Internet y una vista HTTP local que puede iniciar el asistente. El ejemplo consulta GitHub público sin token privado; siguen aplicándose disponibilidad y límites.

Tiempo estimado: 14–26 min

Estimaciones con los archivos iniciales y las cuentas y herramientas necesarias ya listas. La configuración, las colas de publicación y las esperas de correo o DNS requieren tiempo adicional. Las solicitudes sin autenticación de GitHub comparten una cuota basada en la IP; las pruebas repetidas pueden agotarla.

Qué aprenderás

  • Consulta un repositorio público real.
  • Muestra un resultado adicional útil con un asistente.
  • Distingue repositorio inexistente y servicio no disponible.

Archivos del taller

Paso 1

Abre la consulta lista

Pide un valor al servicio en vez de escribir un número fijo.

Pide iniciar la carpeta public sobre HTTP. Usa octocat / Hello-World y activa el botón de consulta.

Compara identidad y cifra devueltas con el servicio en ese momento. No fijes un número antiguo como si fuera actual.

Un ejemplo concreto

Un recuento de estrellas guardado en el texto no cambia cuando cambia el repositorio.

Inicia la consulta pública sobre HTTP local. Conserva el renderizado seguro de texto y no añadas tokens privados al navegador. Ayúdame a probar un repositorio real, uno ausente y un fallo de servicio. Añade el recuento documentado de elementos abiertos y compáralo con la API. Haz los cambios por mí.

GitHub: obtener un repositorio

Archivos de este paso

Start hereArchivos del taller

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Muestra datos de otro servicio

Carga desde GitHub el nombre, la descripción y la cantidad de estrellas de un repositorio público.

Una API es una forma definida para que un programa solicite datos o una acción. Aquí tu sitio pide a GitHub un repositorio y recibe JSON en lugar de una página HTML.

Utilizamos una operación de lectura pública para que aprendas a gestionar solicitudes sin empezar por la autenticación. El resultado puede cambiar entre solicitudes; es una observación actual, no una cifra para fijar en el código.

Ejemplo resuelto

Para el propietario octocat y el repositorio Hello-World, la ruta de solicitud es /repos/octocat/Hello-World en api.github.com. La página muestra los valores devueltos de full_name y stargazers_count.

GitHub: obtener un repositorio

Extra implementation exercise

¿Qué diferencia hay entre copiar una cantidad de estrellas al HTML y consultarla al pulsar el botón?

Mostrar una solución desarrollada

El HTML copiado conserva el valor antiguo hasta que se edita. Una consulta fetch solicita la respuesta actual en ese momento, pero necesita gestionar carga y errores porque el servicio o la red pueden no responder.

  • Explica cuándo se obtiene el valor.
  • Reconoce que la solicitud externa puede fallar.

Paso 2

Comprueba una respuesta correcta

Usa una observación comparable con la fuente.

Pide ver la respuesta pública correspondiente y verifica los valores mostrados. Mantén la prueba pública y sin datos sensibles.

Una respuesta de error no debe tratarse como resultado normal. No necesitas escribir código de peticiones/errores para evaluar lo visible.

Un ejemplo concreto

Valores ilustrativos: full_name = practice/example y stargazers_count = 12 deben convertirse en practice/example y 12 stars visibles. Son valores ficticios para entender la relación, no la cifra actual del ejemplo GitHub.

Archivos de este paso

Start hereArchivos del taller

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Construye y comprueba una solicitud

Codifica la entrada del usuario y examina la respuesta antes de utilizarla.

Lee public/app.js y ejecuta la página proporcionada mediante HTTP. encodeURIComponent mantiene cada valor de propietario y repositorio en su propio segmento de ruta. El servidor de destino está fijado; el visitante no proporciona un endpoint arbitrario.

fetch se resuelve también con errores HTTP como 404, así que esperar su resultado no basta. Comprueba response.ok y los estados relevantes, analiza el JSON y verifica después los campos que necesita la función. textContent muestra las cadenas externas como texto.

El fragmento breve siguiente ilustra la comprobación HTTP general. El app.js completo trata primero de forma específica los 404 y las respuestas restringidas o limitadas por cuota; después comprueba otros estados fallidos, analiza JSON y valida campos. Conserva ese orden al añadir un campo visible.

Ejemplo resuelto

Una descripción con corchetes angulares debe seguir siendo texto visible y no convertirse en marcado de la página. Un 404 debe mostrar un mensaje de repositorio no encontrado o sin acceso público, en vez de una tarjeta de éxito vacía.

if (!response.ok) throw Error('Request failed');
const data = await response.json();
result.textContent = data.full_name;

Extra implementation exercise

¿Por qué try/catch por sí solo no detecta todas las respuestas HTTP fallidas?

Mostrar una solución desarrollada

Los errores HTTP pueden producir un objeto Response normal. Comprueba status/ok y lanza o gestiona el error antes de tratar su cuerpo como el repositorio solicitado.

  • Sabe que fetch puede resolverse con 404 o 500.
  • Comprueba el estado antes de mostrar un resultado correcto.

Paso 3

Prueba ausencia e indisponibilidad

Haz comprensibles los distintos fallos.

Prueba un nombre inexistente y, con ayuda, una petición bloqueada/fallida en local. Conserva la consulta para corregir o reintentar.

Distingue inexistencia y fallo temporal. No añadas un token privado al navegador para saltar límites.

Un ejemplo concreto

«Repositorio no encontrado» y «Servicio no disponible; reintenta» indican acciones siguientes distintas.

GitHub: límites de solicitudes de la API REST

Archivos de este paso

Start hereArchivos del taller

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Haz que los estados de error se distingan

Que no exista el repositorio, que no haya red y que se haya agotado la cuota son problemas diferentes.

Prueba un repositorio público real, un nombre claramente inexistente y el modo sin conexión del navegador. La interfaz borra el resultado anterior antes de una nueva solicitud, impide envíos duplicados y vuelve a habilitar el botón después.

GitHub puede rechazar solicitudes sin autenticar por límites basados en la IP. No lo resuelvas insertando un token privado en el navegador. Para un uso autenticado sostenido, utiliza las credenciales en una ruta controlada de servidor y aplica caché cuando corresponda.

Ejemplo resuelto

Si una tarjeta de éxito sigue visible debajo de “Not found” (no encontrado), el visitante puede confundir los datos antiguos con la consulta nueva. Borrar el resultado anterior deja inequívoco el estado de la solicitud actual.

GitHub: límites de solicitudes de la API REST

Extra implementation exercise

Una consulta falla tras muchas pruebas. ¿Debe indicar la interfaz que el repositorio tiene cero estrellas?

Mostrar una solución desarrollada

No. Cero es un valor real de los datos. Indica que los datos no están disponibles o tienen acceso restringido y examina el estado; la cantidad es desconocida hasta que una respuesta correcta la proporcione.

  • No convierte los datos no disponibles en cero.
  • Comprueba el estado de la solicitud y las pruebas de cuota.

Paso 4

Añade un resultado útil

Describe la información nueva y deja conectarla al asistente.

Pide añadir open_issues_count junto al resultado y etiquetarlo open issues and pull requests. El total de GitHub incluye ambas categorías; no lo llames solo errores. Usa la referencia tras intentar tu versión.

Compara el valor visible con la respuesta y repite éxito, ausencia e indisponibilidad. Tú evalúas significado y resultados; el asistente implementa el navegador.

Un ejemplo concreto

Un open_issues_count ficticio de 5 podría incluir dos issues y tres pull requests abiertas. «5 errores» afirmaría algo que no demuestra el campo.

Archivos de este paso

Start hereArchivos del taller

Open or download the files below. When saving a project, keep the folder paths shown in the filenames.

How it works (optional)

Tu tarea: añadir un campo útil del repositorio

Añade una cantidad de incidencias conservando una separación clara entre datos y errores.

Muestra open_issues_count después de validarlo como número finito. Ten en cuenta que la cantidad del repositorio de GitHub incluye solicitudes de incorporación de cambios, como indica su documentación; no la etiquetes como una cantidad exacta de informes de errores solamente.

Registra una consulta correcta, un repositorio ausente y un intento sin conexión. Incluye lo que ve el visitante durante la solicitud y después de cada resultado.

Ejemplo resuelto

Un texto como “Open issues and pull requests” (incidencias y solicitudes de incorporación de cambios abiertas) explica la medida con más precisión que “Bugs” (errores).

Encontrarás el desarrollo completo de referencia en reference/assignment-walkthrough.txt. Compara sus pasos con tu resultado; rellena el registro de pruebas con observaciones de tu propio proyecto.

Extra implementation exercise

Amplía el resultado con la cantidad documentada de elementos abiertos y demuestra los tres estados.

Mostrar una solución desarrollada

Añade open_issues_count a los campos validados después de gestionar correctamente los estados. Exige un número finito y utiliza el texto 'Open issues and pull requests', porque ese campo del repositorio de GitHub incluye ambos. El script completo de referencia conserva la presentación mediante textContent y los estados existentes de carga y error.

Datos de prueba: full_name='sample/site', stargazers_count=3, open_issues_count=2 produce 'sample/site — 3 stars — 2 open issues and pull requests'. El resultado muestra tres estrellas y dos incidencias o solicitudes abiertas; no afirma que ambos elementos sean errores.

Vuelve a probar un repositorio público correcto, un 404 y el modo sin conexión. Borra la tarjeta anterior al empezar la siguiente consulta; un error no debe conservar cantidades antiguas ni sustituir datos no disponibles por cero.

  • Valida el número añadido y lo etiqueta con precisión.
  • No deja visible un éxito anterior tras fallar una consulta nueva.

¿Te resultó útil esta lección?

Deja un me gusta o compártela con alguien a quien pueda servirle.

Sigue aprendiendo

Explora las otras lecciones