Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Está a ver a documentação do Apigee e do Apigee Hybrid.
Veja a documentação do
Apigee Edge.
Esta secção aborda os antipadrões comuns que surgem quando os proxies de API são implementados no Apigee.
O que é um antipadrão?
Um antipattern é uma prática de design de software ineficaz ou contraproducente, ou seja, o oposto de uma "prática recomendada".
Por outras palavras, um antipadrão é algo que o software lhe permite fazer, mas que pode ter um impacto funcional ou no desempenho adverso.
Por exemplo, considere o "God Class/Object" que soa como omnipotente. Na programação orientada a objetos, uma classe de Deus é uma classe que controla demasiadas classes para uma determinada aplicação, conforme ilustrado pela seguinte árvore de referência:
Figura 1: classe God
Conforme ilustrado na imagem, a classe god usa e faz referência a demasiadas classes.
A framework na qual a aplicação foi desenvolvida não impede a criação de uma classe deste tipo, mas tem muitas desvantagens, sendo as principais as seguintes:
Difícil de manter
Ponto único de falha quando a aplicação é executada
Consequentemente, esta classe é um antipadrão que deve evitar criar.
A boa notícia é que pode identificar estes antipadrões e retificá-los com as práticas recomendadas adequadas, o que fará com que as APIs que implementar no Apigee sirvam melhor o seu propósito pretendido.
Resumo dos antipadrões
A tabela seguinte lista alguns antipadrões de API comuns:
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-21 UTC."],[[["\u003cp\u003eThis documentation outlines common antipatterns encountered when deploying API proxies on Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eAn antipattern is a software design practice that is ineffective or counterproductive, potentially causing adverse functional or performance impacts, as opposed to a best practice.\u003c/p\u003e\n"],["\u003cp\u003eAntipatterns, such as a "God Class" in object-oriented programming, are undesirable practices that can lead to maintenance issues and single points of failure.\u003c/p\u003e\n"],["\u003cp\u003eSeveral policy, generic, and backend antipatterns are detailed, including issues related to caching, quota management, and managing Apigee resources.\u003c/p\u003e\n"],["\u003cp\u003eThe document also provides a link to download a comprehensive eBook that goes over these antipatterns.\u003c/p\u003e\n"]]],[],null,["*You're viewing **Apigee** and **Apigee hybrid** documentation.\nView [Apigee Edge](https://docs.apigee.com/api-platform/antipatterns/intro) documentation.*\n\nThis section is about common antipatterns that arise when API proxies are deployed\non Apigee.\n\nWhat is an antipattern?\n\nAn [*antipattern*](https://en.wikipedia.org/wiki/Anti-pattern) is a software\ndesign practice that is ineffective or\ncounterproductive---in other words, the opposite of a \"best practice.\"\nTo put it another way, an antipattern is something that the software allows you to do, but\nthat may have an adverse functional or performance impact.\n\nFor example, consider the omnipotent-sounding \"God Class/Object\". In objected oriented\nprogramming, a *god class* is a class that controls too many classes\nfor a given application, as illustrated by the following reference tree:\n**Figure 1**: God class\n\nAs the image illustrates, the god class uses and references too many classes.\n\nThe framework on which the application was developed does not prevent the creation of such a\nclass, but it has many disadvantages, the primary ones being:\n\n- Hard to maintain\n- Single point of failure when the application runs\n\nConsequently, such a class is an antipattern that you should avoid creating.\n\nThe good news is that you can identify these antipatterns and rectify them with\nappropriate best practices, which will make the APIs you deploy on Apigee best serve their intended\npurpose.\n\nSummary of antipatterns\n\nThe following table lists some common API antipatterns:\n\n| Category | Antipatterns |\n|----------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Policy antipatterns | - [Issuing refresh tokens without invoking refresh flow](/apigee/docs/api-platform/antipatterns/issuing-refresh-tokens) - [Use waitForComplete() in JavaScript code](/apigee/docs/api-platform/antipatterns/wait-for-complete) - [Set a long expiration time for OAuth tokens](/apigee/docs/api-platform/antipatterns/oauth-long-expiration) - [Use greedy quantifiers in the RegularExpressionProtection policy](/apigee/docs/api-platform/antipatterns/greedy-quantifiers) - [Cache error responses](/apigee/docs/api-platform/antipatterns/caching-error) - [Store data greater than 256 KB size in cache](/apigee/docs/api-platform/antipatterns/caching-large) - [Invoke MessageLogging multiple times in an API proxy](/apigee/docs/api-platform/antipatterns/messagelogging-multiple-times) - [High-cardinality identifiers in Quota policy](/apigee/docs/api-platform/antipatterns/high-cardinality-identifiers-quota-policy) - [Configure non-distributed quota](/apigee/docs/api-platform/antipatterns/non-distributed-quota) - [Reuse a Quota policy](/apigee/docs/api-platform/antipatterns/reusing-quota) - [Use the RaiseFault policy under inappropriate conditions](/apigee/docs/api-platform/antipatterns/raise-fault-conditions) - [Access multi-value HTTP headers incorrectly in an API Proxy](/apigee/docs/api-platform/antipatterns/multi-value-http-headers) - [Use Service Callout to invoke backend service in no target proxy](/apigee/docs/api-platform/antipatterns/service-callout-no-target) |\n| Generic antipatterns | - [Invoke Management API calls from an API Proxy](/apigee/docs/api-platform/antipatterns/invoking-management) - [Invoke a proxy within a proxy using custom code or as a target](/apigee/docs/api-platform/antipatterns/proxy-within-proxy) - [Manage Apigee resources without using source control management](/apigee/docs/api-platform/antipatterns/no-source-control) - [Load Balance with a single target server with MaxFailures set to a non-zero value](/apigee/docs/api-platform/antipatterns/load-balancing-maxfailures) - [Access the request/response payload when streaming is enabled](/apigee/docs/api-platform/antipatterns/payload-with-streaming) - [Define multiple ProxyEndpoints in an API Proxy](/apigee/docs/api-platform/antipatterns/multiple-proxyendpoints) |\n| Backend antipatterns | - [Allow a slow backend](/apigee/docs/api-platform/antipatterns/slow-backend) - [Disable HTTP persistent (reusable keep-alive) connections](/apigee/docs/api-platform/antipatterns/disable-persistent-connections) |\n\nDownload antipatterns eBook\n\nIn addition to the links above, you can also download the antipatterns in eBook format:\n\n- [The Book of Apigee Antipatterns v2.0 (PDF)](https://docs.apigee.com/files/Apigee_Edge_Antipatterns_2_0.pdf)"]]