Configure a gestão de APIs da Apigee no Cloud Code para VS Code

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

Esta página fornece instruções para criar um ambiente de desenvolvimento local da gestão de APIs da Apigee no Cloud Code para VS Code. Consulte a vista geral do desenvolvimento local com o Apigee para ver as funcionalidades no ambiente de desenvolvimento local.

O processo de configuração requer a conclusão de ambas as secções deste guia:

Consoante os seus exemplos de utilização, também pode concluir a configuração do desenvolvimento de proxy de API para o desenvolvimento local do Apigee

Antes de começar

Para configurar e usar o Apigee no VS Code, precisa de:

  1. Um Google Cloud projeto para iniciar sessão no seu ambiente de desenvolvimento local. O projeto tem de ser aprovisionado para que o Apigee crie um espaço de trabalho local do Apigee onde pode desenvolver e testar proxies de API.
  2. (Recomendado) Hub de APIs aprovisionado no seu projeto. O hub de APIs é necessário para a criação de um servidor de simulação remoto para testar as especificações da API.

    Se não quiser adicionar o hub de APIs ao seu projeto, pode associar o projeto a outro projeto que tenha o hub de APIs ativado. Consulte Anexe um projeto de tempo de execução a um hub de APIs para obter informações sobre como anexar um projeto a um hub de APIs.
  3. As funções necessárias para usar o hub de APIs com o desenvolvimento local do Apigee para as ações que planeia realizar.
  4. Familiaridade com o VS Code, como gerir o VS Code e como realizar ações comuns, como aceder às definições e instalar extensões. Consulte a documentação do VS Code.

Instale o VS Code e a extensão Cloud Code

Esta secção fornece as instruções de instalação do VS Code e da extensão Cloud Code no VS Code. Este é o primeiro passo na configuração do desenvolvimento local para o Apigee e é necessário para usar qualquer uma das funcionalidades de desenvolvimento local do Apigee

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

  1. Transfira e instale o Visual Studio Code (VS Code) na sua máquina local, se ainda não estiver instalado.
  2. Instale a extensão do Cloud Code, conforme descrito em Instale a extensão do Cloud Code. Se planeia gerir proxies de API no seu 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 Definições, pesquise Extensões: atualização automática e ative-a para todas as extensões ou para a extensão Cloud Code individualmente.
  4. Reinicie o VS Code.

Funções necessárias para usar o hub de APIs do Apigee com o desenvolvimento local do Apigee

Precisa das funções indicadas abaixo para realizar os passos de conceção e teste de APIs através do hub de APIs do Apigee:

Tarefa Funções necessárias
Ver e editar APIs do hub de APIs Editor ou administrador do Cloud API Hub
Publicar APIs no hub de APIs Editor ou administrador do Cloud API Hub
Configure e faça a gestão de um servidor de simulação remoto para testar APIs Administrador do Artifact Registry
Conta de serviço do Cloud Build
Administrador do Cloud Run
Administrador de utilização de serviços

Consulte a referência de funções básicas e predefinidas do IAM.

Também tem de ter a CLI gcloud instalada.

Configure o desenvolvimento de proxy de API para o desenvolvimento local do Apigee

Conclua os passos nesta secção se quiser usar o seu ambiente de desenvolvimento local para o desenvolvimento e os testes de proxy de API do Apigee. Conclua também estes passos para poder criar um proxy de API a partir de uma especificação OpenAPI.

  1. Crie um espaço de trabalho do Apigee.
  2. Instale o emulador do Apigee.
  3. Adicione um contentor para implementação no emulador do Apigee.

O que se segue?

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