Como criar um proxy de API

Esta é a documentação da Apigee X.
Ver a documentação da Apigee Edge

Crie um proxy simples usando a IU e a API da Apigee, conforme descrito nas seções a seguir.

IU da Apigee

A IU da Apigee fornece um assistente de proxy de API que orienta você nas etapas para criar um novo proxy de API.

Para criar um proxy de API simples usando o assistente de proxy de API:

  1. Faça login na IU da Apigee.
  2. Clique em API Proxies na visualização principal.
  3. Na lista suspensa Environment, selecione o ambiente em que você quer criar um novo proxy de API.

    A IU híbrida exibe uma lista de proxies de API para esse ambiente. Se você ainda não tiver criado nenhum proxy, a lista estará vazia.

  4. Clique em Criar nova.

    O assistente de criação de proxy será iniciado.

  5. Clique em Proxy reverso (mais comum).

    Um proxy reverso

    A página Proxy details é exibida.

  6. Defina seu proxy com as seguintes configurações:
    • Nome: insira getstarted. Se já existir um proxy com esse nome, escolha um nome diferente.
    • Base Path: deixe este conjunto definido como /getstarted. Base Path faz parte do URL usado para fazer solicitações à API. A Apigee usa o URL para corresponder e rotear solicitações recebidas para o proxy da API apropriado.
    • Description (opcional): insira uma descrição para o novo proxy da API, como Get started API proxy.
    • Target (Existing API): insira https://mocktarget.apigee.net. Isso define o URL de destino que a Apigee invoca em uma solicitação para o proxy da API. O serviço simulado está hospedado na Apigee e retorna dados simples. Não requer chave de API ou token de acesso.

    Os detalhes do proxy da API precisam ser semelhantes a este:

    Detalhes do proxy de API

  7. Clique em Próxima.
  8. Na visualização Common policies, em Security: Authorization, selecione Pass through (no authorization).

    Seleção de passagem

  9. Na página Summary, selecione os ambientes de implantação, se quiser, e clique em Create and deploy.

    Create and
      deploy

    Seu novo proxy de API é criado e implantado no ambiente selecionado.

    Tela de implantação
    bem-sucedida

  10. Clique em Edit proxy para exibir a página de detalhes do proxy de API.
  11. Editar lista de
      proxy

Na lista de proxies da API, o status de implantação do proxygetstarted é verde para o ambiente test.

Mostra a lista de proxies da API. O status da implantação getstarted é verde.

Próximas etapas

Depois de criar um proxy de API simples, normalmente uma das seguintes ações é feita:

API Apigee

Crie um proxy de API na organização da Apigee emitindo uma solicitação POST para o seguinte recurso:

https://apigee.googleapis.com/v1/organizations/$ORG/apis

Defina o nome do proxy de API usando o parâmetro de consulta name. Restrinja os caracteres usados no nome ao seguinte: A-Za-z0-9._\-$ %

Se quiser, importe um pacote de configuração de proxy da API seguindo estas etapas:

  • Defina o parâmetro de consulta action como import.
  • Defina o cabeçalho Content-type como multipart/form-data.
  • Passe o nome do pacote de configuração de proxy da API em 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 "file=@helloworld-config.zip"

Em que $TOKEN está definido como seu token de acesso OAuth 2.0, conforme descrito em Como receber um token de acesso OAuth 2.0. Para informações sobre as opções de curl usadas neste exemplo, consulte Como usar curl. Para uma descrição das variáveis de ambiente usadas, consulte Como configurar variáveis de ambiente para solicitações da API Apigee.

Veja a seguir um exemplo de saída:

{
  "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 mais informações, consulte a API Proxies.