Esta página se aplica ao Apigee e ao Apigee híbrido .
Veja a documentação do Apigee Edge .
Crie um proxy na interface do usuário do Apigee ou usando a API, conforme descrito nas seções a seguir.
Campos primários do proxy da API
Siga estas diretrizes ao criar um proxy de API:
Campo | Descrição |
---|---|
Nome do proxy da API | Nome exibido para sua API. Especifique caracteres alfanuméricos, hífen (-) ou sublinhado (_). |
Caminho base do proxy da API | Fragmento de URI que aparece após o endereço http://[host] ou https://[host] do seu proxy de API. A Apigee usa o URI do caminho base para corresponder e encaminhar mensagens de solicitação recebidas para o proxy de API apropriado.Use curingas em caminhos base Use um ou mais curingas nos caminhos base do proxy de API para proteger seus proxies de API no futuro. Permitimos a especificação de um único caractere curinga |
Descrição | (Opcional). Uma descrição para o proxy da API. |
URL de destino/destino de backend | URL (incluindo HTTP ou HTTPS) do serviço de backend que este proxy de API invoca. |
Espaço | (Opcional) Se a sua organização tiver o Apigee Spaces habilitado, você poderá associar o proxy de API a um Space. Para mais informações, consulte Visão geral do Apigee Spaces . |
Etapas para criar um proxy de API
Para criar um proxy de API usando a interface do usuário ou as APIs:
Console do Apigee no Cloud
Para criar um proxy no Apigee no console do Cloud:
- Abra a interface do usuário do Apigee no console do Cloud em um navegador.
- No painel de navegação esquerdo, clique em Desenvolvimento de proxy > Proxies de API .
- No painel Proxies de API , clique em + Criar .
- No painel Criar um proxy , em Modelo de proxy , selecione Proxy reverso (mais comum) .
- Em Detalhes do proxy , insira o seguinte:
- Nome do proxy: insira um nome para o proxy, como
myproxy
. - Caminho base : definido automaticamente como o valor inserido em
Proxy name
. O Caminho base faz parte da URL usada para fazer solicitações à sua API. A Apigee usa a URL para corresponder e encaminhar solicitações recebidas para o proxy de API apropriado. - Descrição (opcional) : insira uma descrição para seu novo proxy de API, como "Testando o Apigee com um proxy simples".
- Destino (API existente): Insira
https://mocktarget.apigee.net
. Isso define a URL de destino que a Apigee invoca em uma solicitação ao proxy da API. O serviço mocktarget é hospedado na Apigee e retorna dados simples. Não requer chave de API ou token de acesso. - Espaço (opcional) : se a sua organização tiver o Apigee Spaces habilitado, você poderá associar o proxy de API a um Espaço selecionado na lista de opções disponíveis. Para mais informações, consulte a Visão geral do Apigee Spaces .
- Clique em Avançar .
- Nome do proxy: insira um nome para o proxy, como
- Implantar (opcional) :
- Ambientes de implantação : Opcional. Use as caixas de seleção para selecionar um ou mais ambientes nos quais implantar seu proxy. Se preferir não implantar o proxy neste momento, deixe o campo "Ambientes de implantação" em branco. Você sempre pode implantar o proxy mais tarde.
- Conta de serviço : opcional. Anexe uma conta de serviço à sua implantação para permitir que seu proxy acesse Google Cloud serviços, conforme especificado na função e nas permissões da conta de serviço.
- Clique em Criar .
O Apigee cria o novo proxy e exibe um resumo dos detalhes do proxy na visualização Resumo do proxy .
Se você optar por implantar o proxy, a seção Implantações exibirá o número de revisão , que é 1 na primeira implantação. A coluna Status exibe os ambientes nos quais o proxy está implantado com um indicador de status verde.
Apigee clássico
Para criar um proxy de API simples na interface clássica do Apigee:
- Faça login na interface do usuário do Apigee .
- Clique em Proxies de API na visualização principal.
- Na lista suspensa Ambiente , selecione o ambiente no qual você deseja criar um novo proxy de API.
A interface híbrida exibe uma lista de proxies de API para esse ambiente. Se você ainda não criou nenhum proxie, a lista estará vazia.
- Clique em Criar novo .
O assistente Criar Proxy é iniciado.
- Clique em Proxy reverso (mais comum) .
A página de detalhes do proxy é exibida.
- Configure seu proxy com as seguintes configurações:
- Nome: Digite
getstarted
. Se já existir um proxy com este nome, escolha um nome diferente. - Caminho base: deixe definido como
/getstarted
. O Caminho base faz parte da URL usada para fazer solicitações à sua API. A Apigee usa a URL para corresponder e encaminhar as solicitações recebidas para o proxy de API apropriado. - Descrição (opcional): insira uma descrição para seu novo proxy de API, como
Get started API proxy
. - Destino (API existente): Insira
https://mocktarget.apigee.net
. Isso define a URL de destino que a Apigee invoca em uma solicitação ao proxy da API. O serviço mocktarget é hospedado na Apigee e retorna dados simples. Não requer chave de API ou token de acesso.
Os detalhes do seu proxy de API devem ser semelhantes aos seguintes:
- Nome: Digite
- Clique em Avançar .
- Na exibição Políticas comuns , em Segurança: Autorização , selecione Passagem (sem autorização) .
- Clique em Avançar .
- Na página Resumo , selecione os ambientes de implantação, se desejar, e clique em Criar e implantar .
Seu novo proxy de API é criado e implantado no ambiente selecionado.
- Clique em Editar proxy para exibir a guia Visão geral no Editor de proxy.
Na lista de proxies de API, o status de implantação do proxy de API getstarted
é verde para o ambiente test
.
API da Apigee
Crie um proxy de API na sua organização Apigee emitindo uma solicitação POST
para o seguinte recurso:
https://apigee.googleapis.com/v1/organizations/$ORG/apis
Você deve definir o nome do proxy da API usando o parâmetro de consulta name
. Restrinja os caracteres usados no nome ao seguinte: A-Za-z0-9._\-$ %
Opcionalmente, você pode importar um pacote de configuração de proxy de API executando as seguintes etapas:
- Defina o parâmetro de consulta
action
paraimport
- Defina o cabeçalho
Content-type
comomultipart/form-data
- Passe o nome do pacote de configuração do proxy da API no seu sistema de arquivos local
O exemplo a seguir demonstra como criar um proxy de API importando um pacote de configuração de proxy de API ( helloworld-config.zip
) no seu sistema de arquivos local usando a API.
curl "https://apigee.googleapis.com/v1/organizations/$ORG/apis?name=helloworld&action=import" \ -X POST \ -H "Authorization: Bearer $TOKEN" \ -H "Content-type: multipart/form-data" \ -F "[email protected]"
Onde $TOKEN
é definido como seu token de acesso OAuth 2.0, conforme descrito em Como obter um token de acesso OAuth 2.0 . Para obter informações sobre as opções curl
usadas neste exemplo, consulte Usando curl . Para obter uma descrição das variáveis de ambiente usadas, consulte Definindo variáveis de ambiente para solicitações da API da Apigee .
A seguir, um exemplo da saída de resposta:
{ "basepaths": [ "/helloworld" ], "configurationVersion": { "majorVersion": 4 }, "createdAt": "1559145292799", "displayName": "helloworld", "entityMetaDataAsProperties": { "bundle_type": "zip", "subType": "Proxy", "lastModifiedAt": "1559145292799", "createdAt": "1559145292799" }, "lastModifiedAt": "1559145292799", "name": "helloworld", "policies": [ "verify-api-key", "remove-query-param-apikey", "OAuth-v20-1" ], "proxies": [ "default" ], "proxyEndpoints": [ "default" ], "resourceFiles": {}, "targetEndpoints": [ "default" ], "targets": [ "default" ], "type": "Application", "revision": "1", "description": "Hello world" }
Para obter mais informações sobre como criar um proxy de API, consulte o método apis.create
na API da Apigee. Para ver todos os métodos disponíveis para proxies de API, consulte a API de proxies de API .
Próximos passos
Depois de criar um proxy de API simples, normalmente você faz um dos seguintes procedimentos:
- Adicione políticas, segurança e outros recursos da plataforma Apigee, conforme descrito em Noções básicas sobre APIs e proxies de API .
- Implante-o no seu cluster, conforme descrito em Implantar um proxy de API .