Falcor Wordpress Router
This project provides a Falcor Router which acts as a middleman (in node.js) for consuming the Wordpress REST API. The goal is a more intelligible, data-centric API for the client with dramatically reduced client network requests.
Basic installation and usage
npm install falcor-wordpress --save
Use it within an express app:
... // basic express boilerplate, app = express();var FalcorServer = ;var wordpressRouter = ;var endpoint = '';app;
A demo running in express with a simple front-end is included.
# install library dependencies npm install # install demo dependencies and run cd demo npm install npm start # open your browser and visit http://localhost:9090
The demo page allows you to test live queries against the offical Wordpress Rest API demo site, including a number of examples to get you started. Watch the server console to see a list of REST endpoints that are being fetched on each flight.
Note: there are some differences betweeen the 1.0 and 2.0 branches of the WP API. This package targets 2.0, and uses a 2.0 endpoint for its demo.
Note 9-28-2015: the official Wordpress Rest API demo site has currently been taken offline; since its status is uncertain, the demo may require that you edit
server.js to point to your own instance of a Wordpress site running the REST API version 2. I'll update with further instructions to that end if it becomes clear that their public demo is permanently offline.
Currently implemented top-level routes
Below are the top-level routes available, along with some example paths that might be requested (try these live on the included demo).
Number of available terms:
These are also available at root, though generally more useful where referenced elsewhere:
Media linked as featured image:
Author of a post:
- taxonomies (meta, terms list)
- posts by term
- more linked subqueries
- additional listings by varied sorts