Paso 4: Probar la API

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Para probar la API de helloworld implementada, haz clic en la pestaña Terminal en Apigee en Cloud Code y, luego, ingresa la siguiente llamada curl:

curl 0:8998/helloworld

Se muestra el siguiente mensaje de error:

Llama a la API en la pestaña de la terminal y obtiene un error de autorización

Dado que habilitaste la autenticación basada en claves de API cuando creaste el proxy de API, debes pasar una clave de API mediante el parámetro de consulta apikey cuando llamas a la API.

Para obtener una clave de API, debes crear un paquete de prueba y configurar los siguientes recursos de prueba:

  • Producto de API que se usa para agrupar la API y hacer que esté disponible para los desarrolladores

  • Desarrollador que creará una app para acceder a la API

  • App de desarrollador que habilitará el acceso a la API mediante una clave de API

Compila y exporta recursos de prueba

  1. Crea un paquete de prueba:
    1. Coloca el cursor sobre la carpeta tests y haz clic en Ícono para crear un paquete de prueba.

      Se muestra + cuando colocas el cursor sobre la carpeta de pruebas

      Se abrirá el asistente para crear un paquete de prueba.

    2. Ingresa mytestbundle para el nombre del paquete de prueba y presiona Intro.

      Se creó el paquete de prueba.

    3. Expande la carpeta mytestbundle para ver su contenido.

      Carpeta de prueba con archivos developerapps.json, developer.json, maps.json y de products.json

  2. Configura el recurso de prueba del producto de la API:
    1. Coloca el cursor sobre el archivo products.json y haz clic en Crea un ícono de producto de API.

      + se muestra cuando colocas el cursor sobre products.json

      Se abrirá el asistente Crear producto de API.

      Primera página del asistente para crear productos de API

    2. Ingrese myproduct para el nombre del producto de la API y presione Intro para confirmar y continuar.
    3. Ingrese myproduct para la descripción del producto de la API y presione Intro para confirmar y continuar.
    4. Selecciona helloworld para agregar el proxy de API al producto de API y haz clic en Aceptar.

      El archivo products.json se abre en el editor con el nuevo producto de API configurado:

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "scopes": [],
          "environments": [],
          "apiResources": [
            "/",
            "/*",
            "/**"
          ],
          "quota": "100",
          "quotaInterval": "1",
          "quotaTimeUnit": "minute",
          "name": "myproduct",
          "displayName": "myproduct",
          "proxies": [
            "helloworld"
          ]
        }
      ]
  3. Configura el recurso de prueba para desarrolladores:
    1. Coloca el cursor sobre el archivo developers.json y haz clic en Crea el ícono de desarrollador de Apigee.

      + se muestra cuando colocas el cursor sobre desarrolladores.json

      Se abrirá el asistente Crear desarrollador.

      Primera página del asistente para crear productos de API

    2. Ingresa los siguientes valores en los mensajes y presiona Intro para confirmar y continuar:
      • Correo electrónico del desarrollador: ahamilton@example.com
      • Nombre de usuario: ahamilton
      • Nombre: Alex
      • Apellido: Hamilton

      El archivo developers.json se abre en el editor con el nuevo desarrollador configurado:

      [
          {
            "attributes": [
              {
                "name": "sample_attribute_0",
                "value": "sample_attribute_value_0"
              }
            ],
            "email": "ahamilton@example.com",
            "userName": "ahamilton",
            "firstName": "Alex",
            "lastName": "Hamilton"
          }
        ]
  4. Configura el recurso de prueba de la app para desarrolladores:
    1. Coloca el cursor sobre el archivo developerapps.json y haz clic en Crea el ícono de la app para desarrolladores.

      + se muestra cuando colocas el cursor sobre developerapps.json

      Se abrirá el asistente para crear una app de desarrollador.

      Primera página del asistente para crear productos de API

    2. Selecciona ahamilton@example.com como el propietario de la app.
    3. Ingresa los siguientes valores en el siguiente conjunto de mensajes y presiona Intro para confirmar y continuar:
      • Nombre de la aplicación: myapp
      • Descripción: myapp
      • URL de devolución de llamada: dejar en blanco
      • Selecciona myproduct para agregarlo a la app y haz clic en OK.
      • Selecciona nunca para el valor de vencimiento.

      El archivo developerapps.json se abre en el editor con la nueva app configurada:

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "developerEmail": "ahamilton@example.com",
          "name": "myapp",
          "displayName": "myapp",
          "callbackUrl": "",
          "apiProducts": [
            "myproduct"
          ],
          "expiryType": "never"
        }
      ]
  5. Exporta los recursos de prueba al emulador de Apigee.

    Coloca el cursor sobre el paquete de prueba mytestbundle y haz clic en Ícono de exportación de recursos de prueba.

    Recursos de prueba activos, que incluyen productos de API, desarrolladores y apps para desarrolladores

    Los recursos de prueba activos aparecen en la sección Emuladores de Apigee, como se muestra en la siguiente figura.

    Recursos de prueba activos, que incluyen productos de API, desarrolladores y apps para desarrolladores

Cómo obtener la clave de API

Obtén las credenciales de la clave de API para tu app de desarrollador:

  1. En la sección emulators, en Active test data, haz clic en Active developer apps.

    El archivo de configuración de apps activo para desarrolladores se abre en el editor. El archivo contiene credenciales para myproduct, como se destaca en la siguiente figura.

    <p><img src="/apigee/docs/api-platform/images/vscode-consumerkey.png" alt="Developer apps with the consumerKey value highlighted."></p>
    

  2. Copia el valor de consumerKey (sin comillas) para el producto de API myproduct.

Probar su API

Prueba tu API con la clave de API:

  1. Pasa la clave de API en tu llamada a curl mediante el parámetro de búsqueda apikey de la siguiente manera:
    curl 0:8998/helloworld?apikey=API_KEY

    Se muestra la siguiente respuesta:

    Hello, Guest!

¡Felicitaciones! Ejecutaste una API en tu entorno local de forma correcta.

En el siguiente paso, aprenderás cómo cambiar el extremo de destino.

1 2 3 4 (SIGUIENTE) Paso 5: Cambia el extremo de destino 6 7 8