Ciclo de vida do desenvolvimento da API

Esta página se aplica à Apigee e à Apigee híbrida.

Confira a documentação da Apigee Edge.

As seções a seguir resumem o ciclo de vida de desenvolvimento da API usando a Apigee.

Desenvolvimento de proxies de API

A Apigee oferece suporte às seguintes opções para o desenvolvimento de proxy de API iterativo:

Para mais informações sobre proxies de API, consulte Noções básicas sobre APIs e proxies de API.

Desenvolvimento em nuvem usando a Apigee

Desenvolva seus proxies de API usando as ferramentas de edição e depuração de proxy de API fornecidas com a Apigee. À medida que você trabalha em um proxy de API, a Apigee salva as iterações da sua configuração como revisão.

Ao implantar um proxy de API, você escolhe uma revisão específica para implantar. Normalmente, a implantação mais recente é implantada e, se necessário, revertida para uma anterior. Consulte Como implantar proxies de API.

Para começar a desenvolver proxies de API usando a Apigee, consulte Como criar um proxy de API simples.

Desenvolvimento local usando Apigee na VS Code

Use a Apigee no Visual Studio Code (VS Code) para desenvolver seus proxies de API e verificar a funcionalidade por meio de testes manuais e de unidade (por exemplo, enviar uma solicitação e ver os resultados).

Depois de concluir a validação local, implante as configurações de proxy da API como arquivos nos seus ambientes da Apigee. Consulte Como implantar proxies de API.

Para começar a desenvolver proxies de API localmente usando a Apigee no VS Code, consulte Como criar seu primeiro proxy de API usando a Apigee em VS Code.

Como implantar proxies de API

Criar ambientes em que implantar proxies de API. A distinção entre os ambientes diferentes é arbitrária. Cada ambiente é simplesmente identificado por um conjunto diferente de endereços de rede (URLs). O objetivo é fornecer um domínio no qual você possa criar e verificar proxies de API antes que a API seja exposta para desenvolvedores externos. Para mais informações, consulte Sobre ambientes e grupos de ambiente.

Ao implantar APIs em vários ambientes, é possível separar o tráfego entre os proxies de API nos quais você está trabalhando em um ambiente de teste e os que estão sendo acessados por aplicativos externos em tempo de execução em um ambiente deprodução.

A Apigee é compatível com os seguintes tipos de implantação em um ambiente:

Tipo Descrição
Proxy Desenvolva e teste seus proxies de API nos ambientes de desenvolvimento da Apigee. Depois, implante-os nos ambientes de teste e produção de integração da Apigee. Consulte Como implantar um proxy de API.
Arquivar Desenvolva e teste seus proxies de API programáveis usando a Apigee no VS Code.

Como adicionar políticas

Com a Apigee, é possível programar o comportamento da API usando políticas, sem escrever nenhum código. Uma política é como um módulo que implementa uma função de gerenciamento específica e limitada. 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. Também é possível escrever scripts e códigos personalizados, como aplicativos JavaScript, que ampliam a funcionalidade do proxy da API e permitem que você inove os recursos básicos de gerenciamento compatíveis com as políticas da Apigee. Para mais informações sobre as políticas da Apigee, consulte O que é uma política?

A Apigee oferece políticas prontas para uso para vários recursos, como gerenciamento de tráfego, segurança, mediação e políticas de extensão. Para ver a lista completa das políticas disponíveis na Apigee, consulte a Visão geral da referência de políticas.

Promovendo a produção

Você escolhe onde implantar uma API. Por exemplo, é possível promover uma revisão em um ambiente de produção para permitir que os desenvolvedores comecem a trabalhar com sua API. Ao mesmo tempo, é possível iterar várias revisões em um ambiente de teste ou local, em que você está adicionando recursos ou ajustando políticas. Em seguida, quando tudo estiver pronto, você poderá implantar a nova revisão no ambiente de produção, substituindo a revisão existente nesse ambiente. Com esse método, sempre é possível ter uma revisão em tempo real da API para os desenvolvedores enquanto desenvolve e testa novos recursos.

Como implantar scripts usando a API Apigee

A Apigee fornece uma API RESTful que permite integrar a implantação e o gerenciamento de proxy de API ao ciclo de vida de desenvolvimento de software (SDLC) da sua organização. Por exemplo, para garantir que os requisitos de segurança, confiabilidade e consistência sejam atendidos, um uso comum da API Apigee é escrever scripts ou códigos que implantem de maneira programática os proxies da API e os promova de um ambiente para outro, conforme de um processo automatizado maior.

Para mais informações, consulte a API Apigee.

Como gerenciar recursos do ambiente

Ambientes fornecem segregação de dados e recursos. Por exemplo, é possível configurar caches diferentes nos seus ambientes test e production que só podem ser acessados por proxies de API em execução nesse ambiente. Além disso, as chaves de API emitidas em um ambiente de teste não são válidas em um ambiente de produção e vice-versa.

Para ter mais controle durante a promoção, é recomendável iterar apenas os proxies de API em um ambiente de teste e fazer algumas alterações necessárias para os proxies de API implantados em um ambiente de produção.

Para fazer isso, você precisa garantir que determinados recursos associados a cada ambiente sejam configurados de maneira que eles possam permanecer estáticos em uma configuração de proxy de API.

  • Mapas de chave-valor (KVMs): se o escopo for o ambiente, garanta que as convenções de nomenclatura sejam usadas para permitir que os proxies da API armazenem dados sem exigir alterações de configuração durante a promoção. Para mais informações, consulte Como usar mapas de chave-valor.
  • URLs de destino: é comum que proxies de API chamem diferentes URLs de back-end durante testes e produção. Use as configurações do TargetServer para criar configurações de TargetEndpoint independentes do ambiente. Veja mais informações em
  • Destinos ServiceCallout: as chamadas de serviço podem usar destinos diferentes dependendo do ambiente, se, por exemplo, uma ServiceCallout no ambiente de teste consome um serviço de demonstração. Consulte Política ServiceCallout.

Para tornar as configurações de proxy da API independentes do ambiente, você também pode usar instruções condicionais. As instruções condicionais criadas com a variável environment.name podem ser usadas para avaliar o ambiente atual antes de aplicar uma política ou antes de rotear para um URL no back-end. Para mais informações, consulte Condições com variáveis de fluxo.