Introdução aos antipadrões

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

Esta seção aborda antipadrões comuns observados como parte dos proxies de API implantados na plataforma Apigee Edge.

A boa notícia é que cada um desses antipadrões pode ser identificado e retificado claramente com as práticas recomendadas adequadas. Desse modo, as APIs implantadas no Edge cumprem a finalidade pretendida e são mais eficientes.

Resumo dos antipadrões

Na tabela a seguir, listamos os antipadrões desta seção:

Categoria	Antipadrões
Antipadrões da política	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 512kb no cache Registrar dados em servidores de terceiros usando a política do JavaScript Uso de uma versão JSONPath não compatível Invocar o MessageLogging várias vezes em um proxy de API 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 Uso de qualquer política OAuth V1, que está descontinuada. Consulte Descontinuações.
Antipadrões de desempenho	Deixar proxies de API NodeJS não utilizados implantados
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 do Edge sem usar o gerenciamento de controle de origem Definir vários hosts virtuais com o mesmo alias de host e número de porta 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)
Antipadrões do Edge para nuvem privada	Adicionar informações personalizadas ao esquema de propriedade da Apigee no banco de dados do Postgres

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 do Apigee Edge v2.0 (PDF)

O que é um antipadrão?

A Wikipédia define um antipadrão de software como:

format_quote

Em engenharia de software, um antipadrão é um padrão que pode ser comumente usado, mas é ineficiente e/ou contraprodutivo, na prática.

format_quote

Para simplificar, um antipadrão é algo que o software permite que o "usuário" faça, mas que pode ter um impacto funcional, operacional ou de desempenho adverso.

Por exemplo, considere a "classe/objeto pai" de nível onipotente.

Na terminologia de objetos, uma classe pai é aquela que controla muitas classes em um determinado aplicativo.

Por exemplo, considere um aplicativo com a seguinte árvore de referência:

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, evite criar esse tipo de classe. Trata-se de um antipadrão.

Público-alvo

Esta seção é mais voltada aos desenvolvedores do Apigee Edge conforme avançam no ciclo de vida de criação e desenvolvimento de proxies de API para serviços. O ideal é que ela seja usada como um guia de referência durante o ciclo de vida de desenvolvimento da API e a solução de problemas.