Antipattern: defina vários ProxyEndpoints num proxy de API
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.
A configuração ProxyEndpoint define a forma como as apps cliente consomem as APIs através do Apigee.
O ProxyEndpoint define o URL do proxy de API e como um proxy se comporta: que políticas aplicar e a que pontos finais de destino encaminhar, bem como as condições que têm de ser cumpridas para que estas políticas ou regras de encaminhamento sejam executadas.
Em resumo, a configuração do ProxyEndpoint define tudo o que tem de ser feito para implementar uma API.
Antipattern
Um proxy de API pode ter um ou mais pontos finais de proxy. A definição de vários ProxyEndpoints é um mecanismo fácil e simples para implementar várias APIs num único proxy. Isto permite-lhe reutilizar políticas e/ou lógica empresarial antes e depois da invocação de um TargetEndpoint.
Por outro lado, quando define vários ProxyEndpoints num único proxy de API, acaba por combinar conceptualmente muitas APIs não relacionadas num único artefacto. Torna os proxies de API mais difíceis de ler, compreender, depurar e manter. Isto contraria a filosofia principal dos proxies de API: facilitar a criação e a manutenção de APIs para os programadores.
Impacto
Vários ProxyEndpoints num proxy de API podem:
Dificultar a compreensão e a manutenção do proxy de API por parte dos programadores.
Obscure as estatísticas. Por predefinição, os dados de estatísticas são agregados ao nível do proxy. Não existe uma discriminação das métricas por ponto final do proxy, a menos que crie relatórios personalizados.
Dificultar a resolução de problemas com proxies de API.
Prática recomendada
Quando estiver a implementar um novo proxy de API ou a reformular um proxy de API existente, use as seguintes práticas recomendadas:
Implemente um proxy de API com um único ProxyEndpoint.
Se existirem várias APIs que partilham um servidor de destino comum e/ou requerem a mesma lógica antes ou depois da invocação do servidor de destino, considere usar fluxos partilhados para implementar essa lógica em diferentes proxies de API.
Se existirem várias APIs que partilham um caminho base de início comum, mas diferem no sufixo,
use fluxos condicionais num único ProxyEndpoint.
Se existir um proxy de API com vários ProxyEndpoints e não houver problemas com o mesmo,
não é necessário tomar nenhuma medida.
A utilização de um ProxyEndpoint por proxy de API resulta no seguinte:
Proxies mais simples e fáceis de manter
As informações melhoradas no Analytics, como o desempenho do proxy e o tempo de resposta do destino, vão ser
comunicadas separadamente em vez de agregadas para todos os ProxyEndpoints
[[["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\u003eApigee ProxyEndpoints define how client apps interact with APIs, including URL, behavior, policies, target routing, and execution conditions.\u003c/p\u003e\n"],["\u003cp\u003eWhile defining multiple ProxyEndpoints in a single API proxy can implement multiple APIs, it can also lead to complexity, making the API proxy harder to understand, debug, and maintain.\u003c/p\u003e\n"],["\u003cp\u003eMultiple ProxyEndpoints obfuscate analytics data, making it harder to break down metrics by proxy endpoint without custom reports and making troubleshooting more difficult.\u003c/p\u003e\n"],["\u003cp\u003eThe best practice is to use one API proxy with a single ProxyEndpoint to promote easier maintenance, clearer analytics, and faster troubleshooting.\u003c/p\u003e\n"],["\u003cp\u003eShared flows can implement common logic across multiple APIs, while conditional flows can handle multiple APIs sharing a base path within a single ProxyEndpoint.\u003c/p\u003e\n"]]],[],null,["# Antipattern: Define multiple ProxyEndpoints in an API proxy\n\n*You're viewing **Apigee** and **Apigee hybrid** documentation.\nView [Apigee Edge](https://docs.apigee.com/api-platform/antipatterns/multiple-proxyendpoints) documentation.*\n\nThe ProxyEndpoint configuration defines the way client apps consume the APIs through Apigee.\nThe ProxyEndpoint defines the URL of the API proxy and how a proxy behaves: which policies to apply\nand which target endpoints to route to, and the conditions that need to be met for these policies or\nroute rules to be executed.\n\nIn short, the ProxyEndpoint configuration defines all that needs to be done to implement an\nAPI.\n\nAntipattern\n-----------\n\nAn API proxy can have one or more proxy endpoints. Defining multiple ProxyEndpoints is an easy\nand simple mechanism to implement multiple APIs in a single proxy. This lets you reuse policies\nand/or business logic before and after the invocation of a TargetEndpoint.\n\nOn the other hand, when defining multiple ProxyEndpoints in a single API proxy, you end up\nconceptually combining many unrelated APIs into a single artifact. It makes the API proxies harder\nto read, understand, debug, and maintain. This defeats the main philosophy of API proxies: making\nit easy for developers to create and maintain APIs.\n\nImpact\n------\n\nMultiple ProxyEndpoints in an API proxy can:\n\n- Make it hard for developers to understand and maintain the API proxy.\n- Obfuscate analytics. By default, analytics data is aggregated at the proxy level. There is no breakdown of metrics by proxy endpoint unless you create custom reports.\n- Make it difficult to troubleshoot problems with API proxies.\n\nBest practice\n-------------\n\nWhen you are implementing a new API proxy or redesigning an existing API proxy, use the\nfollowing best practices:\n\n1. Implement one API proxy with a single ProxyEndpoint.\n2. If there are multiple APIs that share common target server and/or require the same logic pre- or post-invocation of the target server, consider using shared flows to implement such logic in different API proxies.\n3. If there are multiple APIs that share a common starting base path, but differ in the suffix, use conditional flows in a single ProxyEndpoint.\n4. If there exists an API proxy with multiple ProxyEndpoints and if there are no issues with it, then there is no need to take any action.\n\nUsing one ProxyEndpoint per API proxy leads to:\n\n1. Simpler, easier to maintain proxies\n2. Better information in Analytics, such as proxy performance and target response time, will be reported separately instead of rolled up for all ProxyEndpoints\n3. Faster troubleshooting and issue resolution\n\nFurther reading\n---------------\n\n- [API Proxy Configuration Reference](/apigee/docs/api-platform/reference/api-proxy-configuration-reference)\n- [Reusable shared flows](/apigee/docs/api-platform/fundamentals/shared-flows)"]]
