Proposal: document a proxy-side Eureka REST consumer using Apache APISIX

Context

This proposal narrows and supersedes the broader cooperation request in #1444. Instead of proposing a promotional blog, I am asking whether the project would accept a small, tested example of a non-Java proxy-side consumer of the Eureka REST registry.

The Eureka Wiki explains that non-Java consumers can query the registry through its REST endpoints, while eureka-examples currently demonstrates the Java client. Apache APISIX has an existing Eureka discovery implementation that reads the full JSON registry from GET {prefix}/apps and uses eligible instances as gateway upstream nodes.

Proposed contribution

I would like to prepare a small, upstream-focused documentation example using APISIX as the concrete proxy-side consumer.

Proposed scope:

• add one short section to eureka-examples/README.md, or use a Wiki page if maintainers prefer that location
• use a localhost-only, fixed-version example with Eureka v2.0.6, APISIX 3.17.0, and two registered service instances
• show how a Eureka application name maps to an APISIX service_name
• demonstrate the polling delay when an instance is added, removed, or becomes ineligible for traffic
• state explicitly that APISIX is a read-only registry consumer in this integration: it fetches the full registry and does not register instances, renew leases, or consume the delta endpoint
• make no changes to Eureka code, dependencies, APIs, or default behavior

Questions

Would this example be useful in the Eureka project, and which documentation location would you prefer? If third-party consumer examples are out of scope, I will keep the material in the APISIX documentation only.

Yilia Lin, Apache APISIX Committer