Etapa 7: implante em um ambiente da Apigee

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

Depois de concluir o desenvolvimento e os testes locais com a Apigee no VS Code, você estará pronto para implantar a API como um arquivo em um ambiente da Apigee. Nesta etapa, você criará um ambiente da Apigee compatível com a implantação de arquivos e implantará um arquivo da configuração do proxy de API no ambiente da Apigee.

  1. Siga as etapas em Criar um ambiente para realizar o seguinte:
    1. Crie um novo ambiente dev na sua organização da Apigee, ativando Archive como o tipo de implantação. Use a IU ou a API.

      Por exemplo:

      Nova caixa de diálogo de ambiente mostrando as configurações de tipo de implantação de Arquivos

    2. Anexe o ambiente à instância de ambiente de execução usando a API Instances attachment.

      Esse comando aciona uma operação de longa duração. Verifique se o ambiente foi anexado ao ambiente de execução antes de continuar.

    3. Crie um grupo de ambiente, se você ainda não tiver um, usando a API de criação de grupos de ambiente.

      Verifique se o grupo de ambiente foi criado antes de continuar. Verifique o status do novo grupo usando uma solicitação como esta:

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
    4. Anexe o novo ambiente ao grupo de ambientes usando a API Environment group attachment.

      Anexar um ambiente ao grupo deixa os proxies nesse ambiente roteáveis pelos nomes dos hosts no grupo. Isso aciona uma operação de longa duração que pode levar vários minutos para ser concluída. Recomendamos que você aguarde um ou dois minutos antes de prosseguir para a próxima etapa. Enquanto isso, verifique o status da operação como antes.

  2. Implante um arquivo da configuração do proxy de API no ambiente da Apigee.
    1. Na guia Terminal no VS Code na Apigee, navegue até o diretório myapigeeworkspace.
      cd myapigeeworkspace

      Para executar ls, o diretório precisa conter a pasta src.

    2. Execute este comando:
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

      Veja a seguir um exemplo de resposta:

      Using Apigee organization dev
      Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. Execute o seguinte comando na guia Terminal para testar a API:
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
      -H "Host: ENV_GROUP_HOSTNAME" 

    Para mais informações sobre as variáveis neste exemplo e como configurar o acesso à API, consulte Implantar um exemplo de proxy.

    A seguinte mensagem de erro é exibida:

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

    Você precisa criar um produto de API que inclua a API helloworld e, em seguida, criar e registrar um desenvolvedor com o produto da API para receber uma chave de API.

  4. Receber uma chave de API.
    1. Criar um produto da API usando a IU da Apigee:
      1. Selecione Publicar > Produtos da API.
      2. Clique em + Criar.
      3. Insira os detalhes do produto do produto de API.
      4. Digite as seguintes informações nos campos:
        Campo Configuração
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: Público
        Quota: Deixar em branco
        Allowed OAuth scope: Deixar em branco
      5. Na seção Operações, clique em + Adicionar uma operação.
      6. Em Origem, selecione helloworld no menu suspenso Proxy de API.
      7. Em Operação, no campo "Caminho", digite /.

        Não altere os outros campos.

      8. Clique em Salvar para salvar a operação.
      9. Clique em Salvar para salvar o produto da API.
    2. Crie um desenvolvedor na sua organização:
      1. Selecione Publicar > Desenvolvedores no menu de navegação.
      2. Clique em + Desenvolvedor.
      3. Digite as seguintes informações nos campos:
        Campo Configuração
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. Clique em Criar.
    3. Registrar um aplicativo:
      1. Selecione Publicar > Apps.
      2. Clique em + App.
      3. Digite as seguintes informações nos campos:
        Campo Configuração
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: Deixar em branco
        Notes: Deixar em branco
        Expiry: Nunca
        Product:
        1. Clique em Adicionar produto.
        2. Selecione myproduct.
        3. Clique em Adicionar.
        Custom attributes: Deixar em branco
    4. Copie a chave de API.
      1. Na página Apps (Publicar > Apps), clique em myapp.
      2. Na página myapp, clique em Mostrar ao lado de Chave na seção Credenciais. A chave de API está associada ao produto de API que você criou.
      3. Selecione e copie a chave de API.
  5. Execute a chamada de curl novamente transmitindo a chave de API usando o parâmetro de consulta apikey da seguinte maneira:
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    A seguinte resposta é retornada:

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

Parabéns! Você implantou o arquivo da API em um ambiente da Apigee!

Na próxima etapa, você promoverá um arquivo da API para um ambiente de produção da Apigee.

1 2 3 4 5 6 7 (AVANÇAR) Etapa 8: promover um arquivo para a produção