Noções básicas sobre APIs e proxies de APIs

Você está visualizando a documentação do Apigee Edge.
Acesse a documentação da Apigee X.
info

O Apigee Edge permite criar APIs RESTful com facilidade e rapidez, que podem ser consumidas pelos desenvolvedores de apps. Você expõe APIs no Edge criando proxies de API que funcionam como "fachadas" gerenciadas para serviços de back-end. Neste tópico, discutimos a relação entre APIs e proxies de API no Apigee Edge.

Vídeo: veja este vídeo curto para uma introdução aos proxies da API.

O que é uma API?

Uma API é uma interface que facilita que um aplicativo consuma recursos ou dados de outro aplicativo. Ao definir pontos de entrada estáveis e simplificados para a lógica e os dados do aplicativo, as APIs permitem que os desenvolvedores acessem e reutilizem facilmente a lógica do aplicativo criada por outros desenvolvedores. No caso de "Web APIs", essa lógica e dados são expostos na rede.

Como os aplicativos que consomem APIs são sensíveis às alterações, as APIs também implicam um "contrato" O contrato fornece algum nível de garantia de que, com o tempo, a API mudará de maneira previsível.

Com o Apigee Edge, você pode criar APIs e, se já tiver APIs, expô-las diretamente e adicionar uma camada de gerenciamento e visibilidade. Se você tiver serviços ativados para HTTP, como serviços da Web baseados em SOA, eles também poderão ser expostos como APIs via Apigee Edge.

O Edge também permite que você crie APIs implementando aplicativos hospedados na plataforma de serviços de API, sem a necessidade de serviços de back-end. É possível criar esses aplicativos em JavaScript, Java e Node.js.

O que é um proxy de API?

Você expõe APIs no Apigee Edge implementando proxies das APIs. Os proxies das APIs dissociam os serviços de back-end da API do app, protegendo esses apps das mudanças de códigos do back-end. Quando você faz mudanças de back-end nos seus serviços, os apps continuam a chamar a mesma API, sem qualquer interrupção.

Em uma configuração de proxy de API, há dois tipos de endpoints:

  • ProxyEndpoint: define como os aplicativos cliente consomem suas APIs. Configure o ProxyEndpoint para definir o URL do proxy de sua API. O endpoint do proxy também determina se os aplicativos acessam o proxy de API por HTTP ou HTTPS. Geralmente, você anexa políticas ao ProxyEndpoint para impor segurança, verificações de cota e outros tipos de controle de acesso e limitação de taxa.
  • TargetEndpoint: define a maneira como o proxy de API interage com seus serviços de back-end. Você configura o TargetEndpoint para encaminhar solicitações para o serviço de back-end apropriado, incluindo a definição de todas as configurações de segurança, o protocolo HTTP ou HTTPS e outras informações de conexão. Você pode anexar políticas ao TargetEndpoint para garantir que as mensagens de resposta sejam formatadas corretamente para o aplicativo que fez a solicitação inicial.

Você pode visualizar proxies de API como mostrado na imagem abaixo:

As solicitações HTTP entram no endpoint da solicitação de proxy, são passadas para o endpoint da solicitação de destino e enviadas para os serviços de back-end. As respostas HTTP que passam pelo endpoint de resposta de destino são transmitidas para o endpoint de resposta do proxy e voltam para o cliente.

Como criar um proxy de API?

Um proxy de API consiste em um pacote de arquivos de configuração XML e código (como JavaScript e Java). A Apigee fornece várias maneiras para criar proxies de API, incluindo:

  • Como usar a interface de gerenciamento do Edge para definir um proxy de API em uma interface gráfica do usuário (GUI). Para mais informações, consulte Criar um proxy de API simples.
  • Criar arquivos XML, com outros arquivos de suporte, que definem seu proxy de API e, em seguida, importá-los para o Edge.
  • Usar a API de gerenciamento do Edge para criar proxies de API fazendo uma série de solicitações REST para o Edge.
  • Implante um aplicativo Node.js como proxy. Consulte Como implantar um app Node.js independente.

O que é uma política?

Com o Edge, você controla o comportamento da API usando policies, sem precisar escrever código. Uma política é como um módulo que implementa uma função de gerenciamento específica e limitada como parte do fluxo de solicitação/resposta do proxy. As políticas são projetadas para você adicionar tipos comuns de recursos de gerenciamento para uma API com facilidade e segurança. As políticas fornecem recursos como segurança, limitação de taxa, transformação e recursos de mediação, evitando que você precise codificar e manter essa funcionalidade por conta própria.

Criar seu primeiro proxy de API

O Apigee fornece um conjunto de tutoriais que você pode usar para criar sua primeira API. Comece com a opção Criar seu primeiro proxy de API.

Uma ótima maneira de aprender sobre proxies de API é trabalhar com as amostras, conforme descrito em Como usar os proxies de API de amostra.

Saiba mais