Routes

The Zephyr public endpoint is the gateway for client apps and other clouds to interact with underlying services like the CloudStore.

Like all Zephyr components, the Router can be easily replaced as needed for production environments or other needs. For instance, you may want to replace the Router with a specially configured nginx in production.

The Router must perform two tasks:

1. Respond to a GET /services HTTP request
2. Forward any configured routes to the appropriate engine

The services request returns JSON with the available services. This is basically just a list of installed engines and routes.

GET /services

{
    "oauth": {
        "name": "OAuth2",
        "route": "/auth",
        "schema": "http://oauth.net/oauth2",
        "description": "OAuth2 API endpoint for authorizing access to CloudStore data.",
        "private": {
            "forward": "http://127.0.0.1:10002"
         }
    },
    "xdi": {
        "name": "XDI Engine",
        "route": "/xdi",
        "schema": "http://xdi.org/$xdi",
        "description": "Full XDI endpoint for graphs and link contracts.",
        "private": {
            "forward": "http://127.0.0.1:10003"
         }
    },
    "xmpp": {
        "name": "XMPP Engine",
        "route": "/xmpp",
        "schema": "http://xmpp.org/xmpp",
        "description": "XMPP endpoint for accessing data and listening to event channels.",
        "private": {
            "forward": "http://127.0.0.1:9001"
         }
    }
}