Siga as etapas abaixo para criar e implantar um proxy de API de teste. Por fim, teste o proxy de API
enviando uma solicitação HTTP para ele.
Criar e implantar um proxy de API
Permissões exigidas para a tarefa
A criação e a implantação de proxies precisam de um conjunto mínimo de permissões.
Se você tiver o papel de administrador da organização da Apigee, conclua esta tarefa.
Para saber mais sobre outros papéis que podem ser implantados, consulte Papéis da Apigee.
O processo de provisionamento da Apigee não cria e implanta automaticamente um proxy de API. É necessário criar e implantar um proxy manualmente.
Verifique se o nome da sua organização está selecionado no menu suspenso no canto superior esquerdo da IU. O nome da organização é o mesmo que o nome do projeto do Google Cloud.
No painel de navegação à esquerda, clique em Desenvolvimento de proxy > Proxies de API.
Clique em Criar.
A página Criar um proxy é aberta.
Na caixa Modelo de proxy, selecione Proxy reverso (mais comum).
Na Etapa 1: detalhes do proxy, configure o proxy com os seguintes valores:
Nome do parâmetro
Valor
Nome do proxy
hello-world
Caminho base
/hello-world
Target (Existing API)
mocktarget.apigee.net
Clique em Próxima.
Na Etapa 2: implantar (opcional):
Ambientes de implantação: opcional. Use as caixas de seleção para escolher um ou mais
ambientes em que o proxy vai ser implantado.
Se preferir não implantar o proxy neste ponto, deixe o campo Ambientes de implantação em branco. O proxy poderá ser implantado posteriormente.
Conta de serviço: opcional Anexe uma conta de serviço à implantação para permitir que seu
proxy acesse os serviços do Google Cloud, conforme especificado no papel e nas permissões da conta de serviço.
Clique em Criar.
Seu novo proxy de API é criado e implantado no ambiente selecionado.
A página Resumo do proxy do proxy recém-criado é aberta.
Uma marca de seleção verde em Status indica que o
proxy foi implantado com sucesso. Se o proxy não for implantado, consulte Como implantar um proxy de API e siga as etapas para implantá-lo manualmente.
No painel de navegação à esquerda, selecione Gerenciamento > Ambientes > Grupos de ambientes.
Copie o nome do host do grupo de ambientes. Você usará esse nome do host para chamar o proxy de API
nas próximas etapas.
Verifique se o nome da sua organização está selecionado no menu suspenso no canto
superior esquerdo da interface. O nome da organização é o mesmo que o nome do projeto do Google Cloud.
Clique em API Proxies na visualização principal.
Na lista suspensa Selecionar ambiente, selecione um ambiente.
Clique em Criar novo.
Clique em Proxy reverso (mais comum).
Na página Detalhes do proxy, configure o proxy com os seguintes valores:
Nome do parâmetro
Valor
Nome
hello-world
Caminho base
/hello-world
Target (Existing API)
https://mocktarget.apigee.net
Clique em Próxima.
Na página Políticas comuns, em Segurança:
autorização, selecione Transmitir (sem autorização).
Clique em Próxima.
Na página Resumo, em Implantação opcional, selecione o ambiente em que o proxy será implantado.
Clique em Criar e implantar.
O novo proxy de API é criado
e implantado no ambiente selecionado.
Clique em Ir para a lista de proxy. Uma marca de seleção verde em Status indica que o
proxy foi implantado com sucesso. Se o proxy não for implantado, consulte Como implantar um proxy de API e siga as etapas para implantá-lo manualmente.
No painel de navegação à esquerda, selecione Administrador > Ambientes > Grupos.
Clique em Visualizar no console do Google Cloud.
Copie o nome do host do grupo de ambientes. Você usará esse nome do host para chamar o proxy de API
nas próximas etapas.
Configure uma entrada DNS para o host. Veja duas maneiras de realizar essa tarefa:
No registrador, crie um registro A que aponte o nome do host do grupo de ambientes para
o IP mostrado na página do assistente em Configurar DNS. Por exemplo, se o
nome do host for sales.example.com e o IP for 10.23.0.2, aponte o
registro de sales.example.com para o endereço 10.23.0.2.
Use o Google Cloud DNS para mapear um URL para um endereço IP.
Teste o proxy de API enviando a seguinte solicitação em uma janela de terminal:
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-04 UTC."],[[["\u003cp\u003eThis page provides instructions for creating and deploying a test API proxy in Apigee or Apigee hybrid environments, which can be done using either the Apigee UI in the Cloud console or the classic Apigee UI.\u003c/p\u003e\n"],["\u003cp\u003eCreating and deploying API proxies requires specific permissions, notably the Apigee Org Admin role, but alternative roles are detailed in the Apigee roles documentation.\u003c/p\u003e\n"],["\u003cp\u003eThe process involves configuring a reverse proxy with a specified name, base path, and target API, then optionally deploying it to selected environments, with the created proxy being displayed in the Proxy Summary page.\u003c/p\u003e\n"],["\u003cp\u003eAfter deployment, you can test the API proxy by sending an HTTP request to it, either with internal or external access, by setting up a DNS entry and using the provided \u003ccode\u003ecurl\u003c/code\u003e command with the correct environment group hostname.\u003c/p\u003e\n"],["\u003cp\u003eThe page also suggests several next steps, such as taking a tour of Apigee tutorials for learning about guarding against traffic spikes and getting a detailed view of the request/response flow.\u003c/p\u003e\n"]]],[],null,["# Recommended next steps\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\n\n*View [Apigee Edge](https://docs.apigee.com/api-platform/get-started/what-apigee-edge) documentation.*\n\nWhat you're doing in this step\n------------------------------\n\n\nFollow the steps below to create and deploy a test API proxy. Finally,\ntest the API proxy by sending an HTTP request to it.\n\nCreate and deploy an API proxy\n------------------------------\n\n#### Permissions required for this task\n\n\nCreating and deploying proxies requires a minimum set of permissions.\nIf you have the Apigee Org Admin role, you can complete this task.\nTo learn about other roles you can employ, see\n[Apigee roles](/apigee/docs/api-platform/system-administration/apigee-roles).\n\nThe provisioning process for Apigee does not automatically create\nand deploy an API proxy for you. You must create and deploy a proxy manually. \n\n### Apigee UI in the Cloud console\n\nTo create and deploy your first proxy:\n\n1. In the Google Cloud console, go to the **Proxy development \\\u003e API proxies** page.\n\n [Go to API proxies](https://console.cloud.google.com/apigee/proxies)\n2. Be sure that your organization name is selected from the project picker in the **Google Cloud** pane. The organization name is the same as your Google Cloud project name.\n3. Click **+ Create** .\n\n The **Create a proxy** page opens.\n4. In the **Proxy template** box, select **Reverse proxy (most common)**.\n5. In **Step 1: Proxy details** , configure your proxy with the following values:\n\n6. Click **Next**.\n7. In **Step 2: Deploy (optional)** :\n - **Deployment environments** : Optional. Use the checkboxes to select one or more environments in which to deploy your proxy. If you prefer not to deploy the proxy at this point, leave the **Deployment environments** field empty. You can always deploy the proxy later.\n - **Service Account**: Optional. Attach a service account to your deployment to enable your proxy to access Google Cloud services, as specified in the service account's role and permissions.\n8. Click **Create** .\n\n Your new API proxy is created and deployed in the selected environment.\n | **Note:**The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.\n9. The **Proxy summary** page for your newly created proxy opens. A green check mark under **Status** indicates that the proxy was successfully deployed. If the proxy is not deployed, see [Deploying an API proxy](/apigee/docs/api-platform/deploy/ui-deploy-new) and follow the steps to deploy it manually.\n10. In the left navigation pane, select **Management \\\u003e Environments \\\u003e Environment Groups**.\n11. Copy the hostname for your environment group. You'll use this hostname to call the API proxy in the next steps.\n\n### Classic Apigee\n\nTo create and deploy your first proxy:\n\n1. Sign in to the [Apigee UI](https://apigee.google.com).\n2. Be sure that your organization name is selected from the drop-down menu in the upper left corner of the UI. The organization name is the same as your Google Cloud project name.\n3. Click **API Proxies** in the main view.\n4. From the **Select Environment** drop-down list, select an environment.\n5. Click **Create new**.\n6. Click **Reverse proxy (most common)**.\n7. In the **Proxy details** page, configure your proxy with the following values:\n\n8. Click **Next**.\n9. In the **Common policies** page, under **Security:\n Authorization** select **Pass through (no authorization)**.\n10. Click **Next**.\n11. On the **Summary** page, under **Optional Deployment**, select the environment in which to deploy the proxy.\n12. Click **Create and deploy** .\n\n Your new API proxy is created\n and deployed in the selected environment.\n | **Note:**The proxy is not fully deployed instantaneously. It can take up to a minute for the proxy to deploy.\n13. Click **Go to proxy list** . A green check mark under **Status** indicates that the proxy was successfully deployed. If the proxy is not deployed, see [Deploying an API proxy](/apigee/docs/api-platform/deploy/ui-deploy-new) and follow the steps to deploy it manually.\n14. In the left navigation pane, select **Admin \\\u003e Environments \\\u003e Groups**.\n15. Click **View in Google Cloud console**.\n16. Copy the hostname for your environment group. You'll use this hostname to call the API proxy in the next steps.\n17. Close the Google Cloud console.\n\nCall the proxy with internal access\n-----------------------------------\n\nIf you allowed *internal* access in\n[Step 4: Customize access routing](/apigee/docs/api-platform/get-started/configure-routing), follow the instructions in:\n[Calling an API proxy with internal-only access](/apigee/docs/api-platform/get-started/accessing-internal-proxies).\n\nCall the proxy with external access\n-----------------------------------\n\n\nIf you allowed *external* access in\n[Step 4: Customize access routing](/apigee/docs/api-platform/get-started/configure-routing), follow these steps:\n\n1. Set up a DNS entry for your host. Here are two ways to accomplish this task:\n - At your registrar, create an A record pointing your environment group hostname to the IP shown on the wizard page under **Configure DNS** . For example, if your hostname is `sales.example.com` and the IP is 10.23.0.2, then point the record for `sales.example.com` to the address `10.23.0.2`.\n - Use Google [Cloud DNS](/dns/docs) to map a URL to an IP address.\n 2. Test the API proxy by sending the following request in a terminal window: **Note:** DNS changes are published immediately, but may take time to propagate. Because of this delay, you may have to wait up to an hour before you can call the sample proxy. \n\n ```\n curl -v -H \"Host:YOUR_ENV_GROUP_HOSTNAME\" \\\n https://YOUR_INSTANCE_IP_OR_DNS/hello-world\n ```\n\n Where:\n - The value of the `Host` header (\u003cvar translate=\"no\"\u003eYOUR_ENV_GROUP_HOSTNAME\u003c/var\u003e) is the hostname from the **Environments \\\u003e Environment Groups** page.\n\n A successful request returns the string: `Hello, Guest!`.\n If your request is not successful, see [Troubleshooting](/apigee/docs/api-platform/get-started/troubleshooting-install).\n\nNext steps\n----------\n\n- [Take a tour](/apigee/docs/api-platform/get-started/tutorials) of the Apigee tutorials, including:\n - [Guarding against sudden\n traffic spikes](/apigee/docs/api-platform/tutorials/add-spike-arrest).\n - [Getting a detailed view of\n the request/response flow](/apigee/docs/api-platform/tutorials/view-with-trace)."]]
