Antipatrón: definir varios ProxyEndpoints en un proxy de APIs
Organízate con las colecciones
Guarda y clasifica el contenido según tus preferencias.
Estás consultando la documentación de Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
La configuración de ProxyEndpoint define la forma en que las aplicaciones cliente consumen las APIs a través de Apigee.
ProxyEndpoint define la URL del proxy de API y cómo se comporta un proxy: qué políticas se deben aplicar, a qué endpoints de destino se debe dirigir el tráfico y las condiciones que se deben cumplir para que se ejecuten estas políticas o reglas de ruta.
En resumen, la configuración de ProxyEndpoint define todo lo que se debe hacer para implementar una API.
Antipatrón
Un proxy de API puede tener uno o varios endpoints de proxy. Definir varios ProxyEndpoints es un mecanismo sencillo para implementar varias APIs en un solo proxy. Esto te permite reutilizar políticas o lógica empresarial antes y después de invocar un TargetEndpoint.
Por otro lado, al definir varios ProxyEndpoints en un solo proxy de API, se combinan conceptualmente muchas APIs no relacionadas en un solo artefacto. Esto dificulta la lectura, la comprensión, la depuración y el mantenimiento de los proxies de API. Esto va en contra de la filosofía principal de los proxies de API, que es facilitar a los desarrolladores la creación y el mantenimiento de APIs.
Impacto
Varios ProxyEndpoints en un proxy de APIs pueden hacer lo siguiente:
Dificultar que los desarrolladores entiendan y mantengan el proxy de API.
Ofuscar analíticas. De forma predeterminada, los datos analíticos se agregan a nivel de proxy. No hay un desglose de las métricas por endpoint de proxy, a menos que cree informes personalizados.
Dificulta la solución de problemas con los proxies de APIs.
Práctica recomendada
Cuando implementes un nuevo proxy de API o rediseñes uno que ya tengas, sigue estas prácticas recomendadas:
Implementa un proxy de APIs con un solo ProxyEndpoint.
Si hay varias APIs que comparten el mismo servidor de destino o requieren la misma lógica antes o después de la invocación del servidor de destino, considera la posibilidad de usar flujos compartidos para implementar esa lógica en diferentes proxies de API.
Si hay varias APIs que comparten una ruta base de inicio común, pero difieren en el sufijo,
usa flujos condicionales en un solo ProxyEndpoint.
Si existe un proxy de API con varios ProxyEndpoints y no hay ningún problema, no es necesario que hagas nada.
Si se usa un ProxyEndpoint por proxy de API, se obtienen las siguientes ventajas:
Proxies más sencillos y fáciles de mantener
La información de Analytics será más precisa, como el rendimiento del proxy y el tiempo de respuesta objetivo, y se
registrará por separado en lugar de agregarse para todos los ProxyEndpoints.
[[["Es fácil de entender","easyToUnderstand","thumb-up"],["Me ofreció una solución al problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Es difícil de entender","hardToUnderstand","thumb-down"],["La información o el código de muestra no son correctos","incorrectInformationOrSampleCode","thumb-down"],["Me faltan las muestras o la información que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (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)"]]
