Esta página aplica-se ao Apigee e ao Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Depois de concluir o desenvolvimento e os testes locais com o Apigee no VS Code, pode implementar a sua API como um arquivo num ambiente do Apigee. Neste passo, vai criar um ambiente do Apigee que suporte a implementação de arquivos e implementar um arquivo da configuração do proxy de API no ambiente do Apigee.
- Siga os passos em Crie um ambiente para realizar o seguinte:
- Crie um novo ambiente de desenvolvimento na sua organização do Apigee, ativando o arquivo como o tipo de implementação. Use a IU ou a API.
- Anexe o ambiente a uma instância de tempo de execução através da API de anexos de instâncias.
Este comando aciona uma operação de longa duração. Certifique-se de que o ambiente foi anexado ao tempo de execução antes de continuar.
- Crie um grupo de ambientes, se ainda não tiver um, através da
API Create environment groups.
Certifique-se de que o grupo de ambientes foi criado antes de continuar. Pode verificar o estado do seu novo grupo através de um pedido como o seguinte:
curl -i -H "$AUTH" -H "Content-Type:application/json" \ "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
- Associe o novo ambiente ao grupo de ambientes através da API Environment group attachment.
Anexar um ambiente ao grupo torna os proxies nesse ambiente encaminháveis através dos nomes de anfitrião no grupo. Isto aciona uma operação de longa duração que pode demorar vários minutos a ser concluída. Recomendamos que aguarde um ou dois minutos antes de continuar para o passo seguinte. Entretanto, pode verificar o estado da operação como antes.
- Implemente um arquivo da configuração do proxy de API no ambiente do Apigee.
- No separador Terminal no Apigee VS Code, navegue para o diretório myapigeeworkspace.
cd myapigeeworkspace
Quando executar
ls
, o diretório deve conter a pastasrc
. - Execute o seguinte comando:
gcloud beta apigee archives deploy --environment=dev --labels=release=052021
Segue-se um exemplo da resposta:
Using Apigee organization dev Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
- No separador Terminal no Apigee VS Code, navegue para o diretório myapigeeworkspace.
- Execute o seguinte comando no separador Terminal para testar a sua 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 o artigo Implemente um proxy de exemplo.
É apresentada a seguinte mensagem de erro:
{"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey", "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}
Tem de criar um produto API que inclua a API
helloworld
e, em seguida, criar e registar um programador com o produto API para obter uma chave API. - Obtenha uma chave da API.
- Crie um produto de API através da IU do Apigee:
- Aceda à página de produtos da API:
- Clique em + Criar.
- Introduza os detalhes do produto da sua API.
- Introduza as seguintes informações nos campos:
Campo Definição Name:
myproduct Display name:
myproduct Environment:
dev Access:
Público Quota:
Deixe em branco Allowed OAuth scope:
Deixe em branco - Na secção Operações, clique em + Adicionar uma operação.
- Em Origem, selecione helloworld no menu pendente do proxy da API.
- Em Operação, no campo Caminho, introduza
/
.Deixe os outros campos definidos como predefinições.
- Clique em Guardar para guardar a operação.
- Clique em Guardar para guardar o produto API.
Apigee na Cloud Console
Na Google Cloud consola, aceda à página Distribuição > Produtos API.
IU do Apigee Classic
Selecione Publicar > Produtos API.
- Crie um programador na sua organização:
Apigee na Cloud Console
-
Na Google Cloud consola, aceda à página Distribuição > Programadores.
- Clique em + Criar.
- Introduza as seguintes informações nos campos:
Campo Definição First Name:
Alex Last Name:
Hamilton Username:
ahamilton Email:
ahamilton@example.com - Clique em Adicionar.
IU do Apigee Classic
- Selecione Publicar > Programadores no menu de navegação.
- Clique em + Programador.
- Introduza as seguintes informações nos campos:
Campo Definição First Name:
Alex Last Name:
Hamilton Username:
ahamilton Email:
ahamilton@example.com - Clique em Criar.
-
- Registe uma app:
- Abra o editor de apps.
-
Na Google Cloud consola, aceda à página Distribuição > Apps.
- Clique em + Criar.
- Selecione Publicar > Apps.
- Clique em + App.
- Introduza as seguintes informações nos campos:
Campo Definição Name:
myapp Display name:
myapp Developer:
ahamilton@example.com Callback URL:
Deixe em branco Notes:
Deixe em branco Expiry:
Nunca Product:
- Clique em Adicionar produto.
- Selecione myproduct.
- Clique em Adicionar.
Custom attributes:
Deixe em branco - Clique em Criar.
Apigee na Cloud Console
IU do Apigee Classic
- Copie a chave da API.
-
Na Google Cloud consola, aceda à página Distribuição > Apps.
- Clique em myapp.
- Na secção Credenciais, junto a Chave, clique em Mostrar.
- Clique em Copiar.
-
Na página Apps (Publicar > Apps), clique em myapp.
- Na página myapp, clique em Mostrar junto a Chave na secção
Credenciais. Tenha em atenção que a chave da API está associada ao produto da API que criou.
- Selecione e copie a chave da API.
Apigee na Cloud Console
IU do Apigee Classic
-
- Execute novamente a chamada curl transmitindo a chave da API através do parâmetro de consulta
apikey
, da seguinte forma:curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY
É devolvida a seguinte resposta:
{ "root": { "city": "San Jose", "firstName": "John", "lastName": "Doe", "state": "CA" } }
Parabéns! Implementou com êxito o seu arquivo de API num ambiente do Apigee!
No passo seguinte, vai promover o seu arquivo de API para um ambiente de produção do Apigee.
1 2 3 4 5 6 7 (NEXT) Passo 8: promova um arquivo para produção