diff --git a/docs/Routes.md b/docs/Routes.md index c29f9f1e..0ebe732b 100644 --- a/docs/Routes.md +++ b/docs/Routes.md @@ -11,9 +11,6 @@ This document list all routes available in Windshaft-cartodb Maps API server. 1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:layer/:z/:x/:y.(:format) {:user(f),:token(f),:layer(f),:z(f),:x(f),:y(f),:format(f)} (1)`
Notes: Per :layer rendering based on :format [0] -1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)` -
Notes: Map instantiation [0] - 1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:layer/attributes/:fid {:user(f),:token(f),:layer(f),:fid(f)} (1)`
Notes: Endpoint for info windows data, alternative for sql api when tables are private [0] @@ -23,47 +20,60 @@ This document list all routes available in Windshaft-cartodb Maps API server. 1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/static/bbox/:token/:west,:south,:east,:north/:width/:height.:format {:user(f),:token(f),:west(f),:south(f),:east(f),:north(f),:width(f),:height(f),:format(f)} (1)`
Notes: Static Maps API [0] +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:layer/widget/:widgetName {:user(f),:token(f),:layer(f),:widgetName(f)} (1)` +
Notes: By :widgetName per :layer widget [0] + +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/:token/:layer/widget/:widgetName/search {:user(f),:token(f),:layer(f),:widgetName(f)} (1)` +
Notes: By :widgetName per :layer widget search [0] + +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)` +
Notes: Map instantiation [0] + +1. `POST (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)` +
Notes: Map instantiation [0] + +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id/jsonp {:user(f),:template_id(f)} (1)` +
Notes: Named maps JSONP instantiation [1] + +1. `POST (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` +
Notes: Instantiate named map [1] + +1. `OPTIONS (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)` +
Notes: CORS [0] + +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id/:layer/:z/:x/:y.(:format) {:user(f),:template_id(f),:layer(f),:z(f),:x(f),:y(f),:0(f),:format(f)} (1)` +
Notes: Per :layer fixed URL named map tiles [1] + +1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/static/named/:template_id/:width/:height.:format {:user(f),:template_id(f),:width(f),:height(f),:format(f)} (1)` +
Notes: Static map for named maps [1] + +1. `POST (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template) {:user(f)} (1)` +
Notes: Create named map (w/ API KEY) [1] + +1. `PUT (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` +
Notes: Update a named map (w/ API KEY) [1] + +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` +
Notes: Named map retrieval (w/ API KEY) [1] + +1. `DELETE (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` +
Notes: Delete named map (w/ API KEY) [1] + +1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template) {:user(f)} (1)` +
Notes: List named maps (w/ API KEY) [1] + +1. `OPTIONS (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` +
Notes: CORS [1] + +1. `GET /health {} (1)` +
Notes: Health check + 1. `GET / {} (1)`
Notes: Welcome message 1. `GET /version {} (1)`
Notes: Return relevant module versions: mapnik, grainstore, etc -1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id/jsonp {:user(f),:template_id(f)} (1)` -
Notes: Named maps JSONP instantiation [1] - -1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` -
Notes: Named map retrieval (w/ API KEY) [1] - -1. `GET (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template) {:user(f)} (1)` -
Notes: List named maps (w/ API KEY) [1] - -1. `GET (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup)/static/named/:template_id/:width/:height.:format {:user(f),:template_id(f),:width(f),:height(f),:format(f)} (1)` -
Notes: Static map for named maps - -1. `GET /health {} (1)` -
Notes: Healt check - -1. `OPTIONS (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)` -
Notes: CORS [0] - -1. `OPTIONS (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` -
Notes: CORS [1] - -1. `POST (?:/api/v1/map|/user/:user/api/v1/map|/tiles/layergroup) {:user(f)} (1)` -
Notes: Map instantiation [0] - -1. `POST (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template) {:user(f)} (1)` -
Notes: Create named map (w/ API KEY) [1] - -1. `POST (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` -
Notes: Instantiate named map [1] - -1. `PUT (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` -
Notes: Update a named map (w/ API KEY) [1] - -1. `DELETE (?:/api/v1/map/named|/user/:user/api/v1/map/named|/tiles/template)/:template_id {:user(f),:template_id(f)} (1)` -
Notes: Delete named map (w/ API KEY) [1] ## Optional deprecated routes @@ -75,29 +85,29 @@ This document list all routes available in Windshaft-cartodb Maps API server. Something like the following patch should do the trick ```javascript -diff --git a/lib/cartodb/cartodb_windshaft.js b/lib/cartodb/cartodb_windshaft.js -index b9429a2..e6cc5f9 100644 ---- a/lib/cartodb/cartodb_windshaft.js -+++ b/lib/cartodb/cartodb_windshaft.js -@@ -212,6 +212,20 @@ var CartodbWindshaft = function(serverOptions) { - } - }); +diff --git a/lib/cartodb/server.js b/lib/cartodb/server.js +index 5f62850..bca377d 100644 +--- a/lib/cartodb/server.js ++++ b/lib/cartodb/server.js +@@ -215,6 +215,20 @@ module.exports = function(serverOptions) { + * END Routing + ******************************************************************************************************************/ + var format = require('util').format; -+ var routesNotes = Object.keys(ws.routes.routes) -+ .map(function(method) { return ws.routes.routes[method]; }) -+ .reduce(function(previous, current) { current.map(function(r) { previous.push(r) }); return previous;}, []) -+ .map(function(route) { -+ return format("\n1. `%s %s {%s} (%d)`\n
Notes: [DEPRECATED]? ", -+ route.method.toUpperCase(), -+ route.path, -+ route.keys.map(function(k) { return format(':%s(%s)', k.name, k.optional ? 't' : 'f'); } ).join(','), -+ route.callbacks.length ++ var routesNotes = app._router.stack ++ .filter(function(handler) { return !!handler.route; }) ++ .map(function(handler) { ++ return format("\n1. `%s %s {%s} (1)`\n
Notes: [DEPRECATED]? ", ++ Object.keys(handler.route.methods)[0].toUpperCase(), ++ handler.route.path, ++ handler.keys.map(function(k) { ++ return format(':%s(%s)', k.name, k.optional ? 't' : 'f'); ++ }).join(',') + ); + }); + console.log(routesNotes.join('\n')); + - return ws; + return app; };