Configurar o gerenciamento de APIs da Apigee no Cloud Code para VS Code

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

Confira a documentação da Apigee Edge.

Nesta página, você encontra instruções para criar um ambiente de desenvolvimento local do gerenciamento de APIs da Apigee no Cloud Code para VS Code. Consulte Visão geral do desenvolvimento local com a Apigee para conhecer os recursos do ambiente de desenvolvimento local.

O processo de configuração exige a conclusão destas duas seções deste guia:

Dependendo dos seus casos de uso, também conclua Configurar o desenvolvimento de proxy de API para o desenvolvimento local da Apigee.

Antes de começar

Para configurar e usar a Apigee no VS Code, você precisa de:

  1. Um projeto Google Cloud para fazer login no ambiente de desenvolvimento local. O projeto precisa ser provisionado para que a Apigee crie um espaço de trabalho local em que você possa desenvolver e testar proxies de API.
  2. (Recomendado) Hub de APIs provisionado no seu projeto. O hub de APIs é necessário para a criação de um servidor simulado remoto para testar especificações de API.

    Se não quiser adicionar o hub de APIs ao seu projeto, associe-o a outro projeto que tenha o hub de APIs ativado. Consulte Anexar um projeto de ambiente de execução a um hub de APIs para saber como anexar um projeto a um hub de APIs.
  3. Os papéis necessários para usar o hub de API com o desenvolvimento local da Apigee para as ações que você planeja realizar.
  4. Familiaridade com o VS Code, como gerenciar o VS Code e como realizar ações comuns, como acessar configurações e instalar extensões. Consulte a documentação do VS Code.

Instalar o VS Code e a extensão do Cloud Code

Esta seção fornece instruções para instalar o VS Code e a extensão do Cloud Code no VS Code. Essa é a primeira etapa na configuração do desenvolvimento local para a Apigee e é necessária para usar qualquer um dos recursos de desenvolvimento local da Apigee.

Para instalar o VS Code e a extensão do Cloud Code:

  1. Faça o download e instale o Visual Studio Code (VS Code) na máquina local, se ainda não tiver instalado.
  2. Instale a extensão do Cloud Code, conforme descrito em Instalar a extensão do Cloud Code. Se você planeja gerenciar proxies de API no ambiente local, instale o Docker como parte do processo.
  3. (Recomendado) Ative as atualizações automáticas para a extensão do Cloud Code. Em Configurações, pesquise Extensões: atualização automática e ative para todas as extensões ou para a extensão do Cloud Code individualmente.
  4. Reinicie o VS Code.

Papéis necessários para usar o hub da API Apigee com o desenvolvimento local da Apigee

Você vai precisar das funções listadas abaixo para realizar etapas de design e teste de API usando o hub de API do Apigee:

Tarefa Papéis necessários
Visualizar e editar APIs do hub de API Editor ou administrador do hub de APIs do Cloud
Publicar APIs no hub de API Editor ou administrador do hub de APIs do Cloud
Configurar e gerenciar um servidor simulado remoto para testar APIs Administrador do Artifact Registry
Conta de serviço do Cloud Build
Administrador do Cloud Run
Administrador do uso do serviço

Consulte a referência de papéis básicos e predefinidos do IAM.

A CLI gcloud também precisa estar instalada.

Configurar o desenvolvimento local de proxy de API para a Apigee

Conclua as etapas desta seção se quiser usar seu ambiente de desenvolvimento local para desenvolvimento e teste de proxy de API da Apigee. Conclua também estas etapas para criar um proxy de API com base em uma especificação OpenAPI.

  1. Crie um espaço de trabalho da Apigee.
  2. Instale o emulador da Apigee.
  3. Adicione um contêiner para implantação no emulador da Apigee.

A seguir

Depois de concluir as etapas de instalação e configuração, comece a usar o Cloud Code: