Introdução aos antipadrões

Esta é a documentação da Apigee e da Apigee híbrida.
Confira a documentação da Apigee Edge.

Nesta seção, abordamos os antipadrões comuns que surgem quando os proxies de API são implantados na Apigee.

O que é um antipadrão?

Um antipadrão é uma prática de design de software ineficaz ou contraprodutiva, em outras palavras, o oposta a uma "prática recomendada". Em outras palavras, um antipadrão é algo que o software permite, mas que pode ter um impacto funcional ou de desempenho adverso.

Por exemplo, considere a "classe/objeto pai" de nível onipotente. Na programação orientada por objetos, uma classe pai é aquela que controla muitas classes em um determinado aplicativo, conforme ilustrado pela árvore de referência a seguir:

Figura 1: classe pai

Conforme ilustrado na imagem, a classe pai usa e refere-se a muitas classes.

O framework em que o aplicativo foi desenvolvido não impede a criação desse tipo de classe, mas isso apresenta muitas desvantagens, sendo as principais:

• Difícil de manter
• Ponto único de falha quando o aplicativo é executado

Consequentemente, essa classe é um antipadrão que você deve evitar criar.

A boa notícia é que você pode identificar esses antipadrões e retificá-los com as práticas recomendadas apropriadas, para que as APIs implantadas na Apigee atendam melhor à finalidade pretendida.

Resumo dos antipadrões

A tabela a seguir lista alguns antipadrões comuns da API:

Categoria	Antipadrões
Antipadrões da política	Emitir tokens de atualização sem invocar o fluxo de atualização Usar waitForComplete() no código JavaScript Definir um prazo de validade longo para tokens OAuth Usar quantificadores rigorosos na política RegularExpressionProtection Respostas de erro do cache Armazenar dados com tamanho superior a 256 KB no cache Invocar o MessageLogging várias vezes em um proxy de API Identificadores de alta cardinalidade na política de cotas Configurar uma cota não distribuída Reutilizar uma política de cotas Usar a política RaiseFault em condições inadequadas Acessar cabeçalhos HTTP de vários valores incorretamente em um proxy de API Usar o Service Callout para invocar o serviço de back-end no proxy sem destino
Antipadrões genéricos	Invocar as chamadas da API Management de um proxy de API Invocar um proxy dentro de um proxy usando código personalizado ou como destino Gerenciar recursos da Apigee sem usar o gerenciamento do controle de origem Balanceamento de carga com um único servidor de destino com MaxFailures definido como um valor diferente de zero Acessar o payload de solicitação/resposta quando o streaming está ativado Definir vários ProxyEndpoints em um proxy de API
Antipadrões de back-end	Permitir um back-end lento Desativar conexões HTTP persistentes (sinal de atividade reutilizável)

Fazer o download do e-book de antipadrões

Além dos links acima, é possível fazer o download dos antipadrões no formato de e-book:

• O livro dos antipadrões da Apigee v2.0 (PDF)