Paso 7: Implementar en un entorno de Apigee

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

Consulta la documentación de Apigee Edge.

Después de completar el desarrollo y las pruebas locales con Apigee en VS Code, podrás implementar tu API como un archivo en un entorno de Apigee. En este paso, creará un entorno de Apigee que admita la implementación de archivos e implementará un archivo de la configuración de proxy de API en el entorno de Apigee.

  1. Sigue los pasos que se indican en Crea un entorno para realizar lo siguiente:
    1. Crea un nuevo entorno de desarrollo en tu organización de Apigee y habilita Archive como tipo de implementación. Usa la IU o la API.

      Por ejemplo:

      Nuevo diálogo de entorno que muestra la configuración de tipo de implementación de Archive

    2. Conecta el entorno a la instancia de entorno de ejecución con la API del adjunto de instancias.

      Este comando activa una operación de larga duración. Comprueba que el entorno se haya adjuntado al entorno de ejecución antes de continuar.

    3. Crea un grupo de entornos si aún no tienes uno con la API de creación de grupos de entornos.

      Asegúrate de que el grupo de entornos se haya creado antes de continuar. Puedes verificar el estado de tu grupo nuevo mediante 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 entorno nuevo al grupo con la API de adjunto de grupos de entorno.

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

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

      Cuando ejecutas 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 proporciona 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 su 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 Implementa un proxy de muestra.

    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, luego, crear y registrar un desarrollador con el producto de API para obtener una clave de API.

  4. Cómo obtener una clave de API
    1. Crea un proxy de API mediante la IU de Apigee:
      1. Selecciona Publicar > Productos de API.
      2. Haz clic en Crear.
      3. Ingresa los detalles del producto para el producto de API.
      4. Ingresa la siguiente información en los campos de registro:
        Campo Configuración
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: Pública
        Quota: Déjelo en blanco
        Allowed OAuth scope: Déjelo en blanco
      5. En la sección Operaciones, haz clic en AGREGAR UNA OPERACIÓN.
      6. En Fuente, selecciona helloworld en el menú desplegable del Proxy de API.
      7. En Operación, en el campo Ruta de acceso, ingresa /.

        Deja los otros campos con sus valores predeterminados.

      8. Haz clic en Guardar para guardar la operación.
      9. Haz clic en Save para guardar el producto de API.
    2. Crea un desarrollador en tu organización:
      1. Selecciona Publicar > Desarrolladores en el menú de navegación.
      2. Haz clic en + Desarrollador.
      3. Ingresa la siguiente información en los campos de registro:
        Campo Configuración
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. Haga clic en Crear.
    3. Registra una aplicación:
      1. Selecciona Publicar > Apps.
      2. Haga clic en + App.
      3. Ingresa la siguiente información en los campos de registro:
        Campo Configuración
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: Déjelo en blanco
        Notes: Déjelo en blanco
        Expiry: Nunca
        Product:
        1. Haz clic en Agregar producto.
        2. Seleccione myproduct.
        3. Haga clic en Add.
        Custom attributes: Déjelo en blanco
    4. Copie la clave de API.
      1. En la página Apps (Publish > Apps), haz clic en myapp.
      2. En la página miapp, haz clic en Mostrar junto a Clave en la sección Credenciales. Ten en cuenta que la clave de API está asociada al producto de API que creaste.
      3. Selecciona y copia la clave de API.
  5. Ejecuta nuevamente la llamada curl y pasa la clave de API con el parámetro de búsqueda apikey de la siguiente manera:
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    Se muestra la siguiente respuesta:

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

¡Felicitaciones! Implementó correctamente el archivo de API en un entorno de Apigee.

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

Próximo paso

1 2 3 4 5 6 7 (SIGUIENTE) Paso 8: Promociona un archivo en producción