Obtener datos de internet

En el Capítulo 3, usaste el paquete http para hacer una solicitud simple. Ahora, volverás a visitar HTTP para construir un cliente de API robusto y listo para producción dentro del paquete wikipedia. Aprenderás a manejar parámetros de consulta (query parameters), mapear respuestas JSON a tus modelos de datos y exportar estas funciones para usarlas en tu CLI.

Antes de comenzar este capítulo, asegúrate de:

• Haber completado el Capítulo 10 y tener un entorno de desarrollo de Dart en funcionamiento con el proyecto dartpedia.
• Entender conceptos básicos de redes (como APIs y solicitudes HTTP).
• Entender formatos básicos de serialización de datos como JSON.

En este capítulo, irás más allá de los simples scripts e implementarás una capa de API adecuada. Trabajarás dentro del paquete wikipedia para implementar la lógica del cliente de API, lo que mejora la escalabilidad y mantenibilidad de tu aplicación.

Para realizar solicitudes HTTP, necesitas agregar el paquete http como una dependencia al paquete wikipedia.

1. Abre el archivo wikipedia/pubspec.yaml dentro de tu proyecto.

2. Localiza la sección dependencies.

3. Agrega http: ^1.3.0 (o la última versión estable) bajo dependencies.

   yaml

   dependencies:
     http: ^1.3.0
   

   content_copy

4. Guarda el archivo pubspec.yaml.

5. Ejecuta dart pub get en tu terminal desde el directorio wikipedia.

A continuación, crearás las funciones de la API para obtener datos de Wikipedia. Crearás tres archivos:

• summary.dart: Este archivo contendrá funciones para recuperar resúmenes de artículos.
• search.dart: Este archivo manejará las consultas de búsqueda para encontrar artículos.
• get_article.dart: Este archivo contendrá funciones para obtener el contenido completo de un artículo.

1. Crea el directorio wikipedia/lib/src/api.

2. Crea el archivo wikipedia/lib/src/api/summary.dart.

3. Agrega el siguiente código a wikipedia/lib/src/api/summary.dart:

   dart

   import 'dart:convert';
   import 'dart:io';
   ​
   import 'package:http/http.dart' as http;
   ​
   import '../model/summary.dart';
   ​
   Future<Summary> getRandomArticleSummary() async {
     final http.Client client = http.Client();
     try {
       final Uri url = Uri.https(
         'en.wikipedia.org',
         '/api/rest_v1/page/random/summary',
       );
       final http.Response response = await client.get(url);
       if (response.statusCode == 200) {
         final Map<String, Object?> jsonData =
             jsonDecode(response.body) as Map<String, Object?>;
         return Summary.fromJson(jsonData);
       } else {
         throw HttpException(
           '[WikipediaApiClient.getRandomArticleSummary] '
           'statusCode=${response.statusCode}, body=${response.body}',
         );
       }
     } on FormatException {
       // todo: log exceptions
       rethrow;
     } finally {
       client.close();
     }
   }
   ​
   Future<Summary> getArticleSummaryByTitle(String articleTitle) async {
     final http.Client client = http.Client();
     try {
       final Uri url = Uri.https(
         'en.wikipedia.org',
         '/api/rest_v1/page/summary/$articleTitle',
       );
       final http.Response response = await client.get(url);
       if (response.statusCode == 200) {
         final Map<String, Object?> jsonData =
             jsonDecode(response.body) as Map<String, Object?>;
         return Summary.fromJson(jsonData);
       } else {
         throw HttpException(
           '[WikipediaApiClient.getArticleSummaryByTitle] '
           'statusCode=${response.statusCode}, body=${response.body}',
         );
       }
     } on FormatException {
       // todo: log exceptions
       rethrow;
     } finally {
       client.close();
     }
   }
   

   content_copy

   Este código define dos funciones: getRandomArticleSummary y getArticleSummaryByTitle. Ambas funciones usan el paquete http para realizar solicitudes GET a la API de Wikipedia y devuelven un objeto Summary. getRandomArticleSummary obtiene un resumen de un artículo aleatorio, mientras que getArticleSummaryByTitle obtiene un resumen para el título de un artículo específico.

4. A continuación, crea el archivo wikipedia/lib/src/api/search.dart.

5. Agrega el siguiente código a wikipedia/lib/src/api/search.dart:

   dart

   ​
   import 'dart:convert';
   import 'dart:io';
   ​
   import 'package:http/http.dart' as http;
   ​
   import '../model/search_results.dart';
   ​
   Future<SearchResults> search(String searchTerm) async {
     final http.Client client = http.Client();
     try {
       final Uri url = Uri.https(
         'en.wikipedia.org',
         '/w/api.php',
         <String, Object?>{
           'action': 'opensearch',
           'format': 'json',
           'search': searchTerm,
         },
       );
       final http.Response response = await client.get(url);
       if (response.statusCode == 200) {
         final List<Object?> jsonData = jsonDecode(response.body) as List<Object?>;
         return SearchResults.fromJson(jsonData);
       } else {
         throw HttpException(
           '[WikipediaApiClient.search] '
           'statusCode=${response.statusCode}, '
           'body=${response.body}',
         );
       }
     } on FormatException {
       rethrow;
     } finally {
       client.close();
     }
   }
   

   content_copy

   Este código define la función search, que utiliza el paquete http para realizar una solicitud GET al endpoint opensearch de la API de Wikipedia y devuelve un objeto SearchResults. El endpoint opensearch se utiliza para buscar artículos de Wikipedia basados en un término de búsqueda.

6. Crea el archivo wikipedia/lib/src/api/get_article.dart.

7. Agrega el siguiente código a wikipedia/lib/src/api/get_article.dart:

   dart

   import 'dart:convert';
   import 'dart:io';
   ​
   import 'package:http/http.dart' as http;
   ​
   import '../model/article.dart';
   ​
   Future<List<Article>> getArticleByTitle(String title) async {
     final http.Client client = http.Client();
     try {
       final Uri url = Uri.https(
         'en.wikipedia.org',
         '/w/api.php',
         <String, Object?>{
           // order matters - explaintext must come after prop
           'action': 'query',
           'format': 'json',
           'titles': title.trim(),
           'prop': 'extracts',
           'explaintext': '',
         },
       );
       final http.Response response = await client.get(url);
       if (response.statusCode == 200) {
         final Map<String, Object?> jsonData =
             jsonDecode(response.body) as Map<String, Object?>;
         return Article.listFromJson(jsonData);
       } else {
         throw HttpException(
           '[WikipediaApiClient.getArticleByTitle] '
           'statusCode=${response.statusCode}, '
           'body=${response.body}',
         );
       }
     } on FormatException {
       // TODO: log
       rethrow;
     } finally {
       client.close();
     }
   }
   

   content_copy

   Este código define la función getArticleByTitle, que utiliza el paquete http para realizar una solicitud GET a la API de Wikipedia y devuelve un objeto List<Article>. Esta función recupera el contenido de un artículo de Wikipedia basándose en su título.

Ahora que has creado las funciones de la API, necesitas exportarlas desde la librería wikipedia para que puedan ser utilizadas por el paquete cli. También exportarás los modelos existentes.

1. Abre el archivo wikipedia/lib/wikipedia.dart.

2. Agrega las siguientes sentencias export al archivo:

   dart

   export 'src/api/get_article.dart';
   export 'src/api/search.dart';
   export 'src/api/summary.dart';
   export 'src/model/article.dart';
   export 'src/model/search_results.dart';
   export 'src/model/summary.dart';
   export 'src/model/title_set.dart';
   

   content_copy

   Estas sentencias export hacen que las funciones y modelos de la API estén disponibles para otros paquetes que dependan del paquete wikipedia.

Ahora que has implementado las funciones de la API y actualizado las dependencias del paquete, es una buena práctica ejecutar las pruebas que creaste en el capítulo anterior. Esto confirmará que tus cambios no han roto la funcionalidad existente del paquete wikipedia.

1. Abre tu terminal y navega al directorio wikipedia/test.

2. Elimina el archivo de prueba predeterminado ejecutando el comando rm wikipedia_test.dart (en macOS o Linux) o del wikipedia_test.dart (en Windows). Este archivo se generó automáticamente pero no se utiliza en nuestro proyecto.

3. Abre tu terminal y navega al directorio wikipedia.

4. Ejecuta el comando dart test.

   Deberías ver una salida similar a esta, confirmando que todas tus pruebas existentes aún pasan:

   bash

   00:02 +3: All tests passed!
   This confirms that the wikipedia package is still working as expected.
   

   content_copy

En la siguiente lección, completarás la CLI integrando el paquete wikipedia con el paquete cli. Implementarás la lógica de comandos y mostrarás los resultados al usuario.