Paso 7: Despliega en un entorno de Apigee

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

Consulta la documentación de Apigee Edge.

Una vez que hayas completado el desarrollo y las pruebas locales con Apigee en VS Code, podrás desplegar tu API como un archivo en un entorno de Apigee. En este paso, crearás un entorno de Apigee que admita el despliegue de archivos y desplegarás un archivo de la configuración de tu proxy de API en el entorno de Apigee.

  1. Sigue los pasos que se indican en Crear un entorno para hacer lo siguiente:
    1. Crea un entorno dev en tu organización de Apigee y habilita Archive como tipo de despliegue. Usa la interfaz de usuario o la API.
    2. Adjunta el entorno a una instancia de tiempo de ejecución mediante la API de adjuntos de instancias.

      Este comando activa una operación de larga duración. Asegúrate de que el entorno se ha adjuntado al tiempo de ejecución antes de continuar.

    3. Crea un grupo de entornos si aún no tienes uno con la API Create environment groups.

      Asegúrate de que el grupo de entornos se ha creado antes de continuar. Puedes consultar el estado de tu nuevo grupo con una solicitud como la siguiente:

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
    4. Adjunta el nuevo entorno al grupo de entornos mediante la API de adjuntos de grupos de entornos.

      Al asociar un entorno al grupo, los proxies de ese entorno se pueden enrutar a través de los nombres de host del grupo. Esto activa una operación de larga duración que puede tardar varios minutos en completarse. Te recomendamos que esperes un minuto o dos antes de continuar con el siguiente paso. Mientras tanto, puedes consultar el estado de la operación como antes.

  2. Despliega un archivo de la configuración de tu proxy de API en el entorno de Apigee.
    1. En la pestaña Terminal de Apigee en VS Code, ve al directorio myapigeeworkspace. 
      cd myapigeeworkspace

      Cuando ejecutes ls, el directorio debe contener la carpeta src.

    2. Ejecuta el siguiente comando: 
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

      A continuación, se muestra un ejemplo de la respuesta: 

      Using Apigee organization dev
Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. Ejecuta el siguiente comando en la pestaña Terminal para probar tu API: 
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
  -H "Host: ENV_GROUP_HOSTNAME"

    Para obtener más información sobre las variables de este ejemplo y cómo configurar el acceso a la API, consulta Implementar un proxy de ejemplo.

    Se muestra el siguiente mensaje de error: 

    {"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey",
  "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

    Debes crear un producto de API que incluya la API helloworld y, a continuación, crear y registrar un desarrollador con el producto de API para obtener una clave de API.

  4. Obtén una clave de API.
    1. Crea un producto de API con la interfaz de usuario de Apigee:
      1. Ve a la página de productos de API:

        En la Google Cloud consola, ve a la página Distribución > Productos de API.

        Ir a productos de API

      2. Haz clic en + Crear.
      3. Introduce los detalles del producto de la API.
      4. Escribe los datos indicados en estos campos:
        Campo Ajuste
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: Público
        Quota: Dejar en blanco
        Allowed OAuth scope: Dejar en blanco
      5. En la sección Operaciones, haz clic en + Añadir una operación.
      6. En Fuente, selecciona helloworld en el menú desplegable de proxy de API.
      7. En Operación, en el campo Ruta, introduce /.

        Deja los demás campos con sus valores predeterminados.

      8. Haz clic en Guardar para guardar la operación.
      9. Haga clic en Guardar para guardar el producto de la API.
    2. Crea un desarrollador en tu organización:

      1. En la Google Cloud consola, ve a la página Distribución > Desarrolladores.

        Ir a Desarrolladores

      2. Haz clic en + Crear.
      3. Escribe los datos indicados en estos campos:
        Campo Ajuste
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. Haz clic en Añadir.
    3. Registrar una aplicación:
      1. Abre el editor de aplicaciones.

        1. En la consola Google Cloud , ve a la página Distribución > Aplicaciones.

          Ir a Aplicaciones

        2. Haz clic en + Crear.
      2. Escribe los datos indicados en estos campos:
        Campo Ajuste
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: Dejar en blanco
        Notes: Dejar en blanco
        Expiry: Nunca
        Product:
        1. Haga clic en Añadir producto.
        2. Seleccione myproduct.
        3. Haz clic en Añadir.
        Custom attributes: Dejar en blanco
      3. Haz clic en Crear.
    4. Copia la clave de API.

      1. En la Google Cloud consola, ve a la página Distribución > Aplicaciones.

        Ir a Aplicaciones

      2. Haz clic en myapp.
      3. En la sección Credenciales, junto a Clave, haz clic en Mostrar.
      4. Haz clic en Copiar.
  5. Vuelve a ejecutar la llamada curl transfiriendo la clave de API mediante el parámetro de consulta apikey, como se indica a continuación: 
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    Se devuelve la siguiente respuesta:

    {
  "root": {
    "city": "San Jose",
    "firstName": "John",
    "lastName": "Doe",
    "state": "CA"
  }
}

¡Enhorabuena! Has desplegado correctamente tu archivo de API en un entorno de Apigee.

En el siguiente paso, ascenderás tu archivo de API a un entorno de producción de Apigee.

1 2 3 4 5 6 7 Paso 8: Promocionar un archivo a producción