Wondering what’s next for npm?Check out our public roadmap! »

    falcor-wordpress

    0.3.0 • Public • Published

    Falcor Wordpress Router

    npm version

    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.

    Getting Started

    Basic installation and usage

    npm install falcor-wordpress --save
    

    Use it within an express app:

    ... // basic express boilerplate, app = express();
     
    var FalcorServer = require('falcor-express');
    var wordpressRouter = require('falcor-wordpress');
    var endpoint = 'http://demo.wp-api.org/wp-json/wp/v2';
     
    app.use('/model.json', FalcorServer.dataSourceRoute(function (req, res) {
      // without authentication
      return wordpressRouter(endpoint);
    }));

    Included Demo

    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).

    postsById

    Basic example: postsById[171,131]["title","slug","link"]

    {
       "postsById": {
          "131": {
             "title": "Ipsam mollitia eveniet hic",
             "slug": "ipsam-mollitia-eveniet-hic",
             "link": "http://demo.wp-api.org/2015/08/21/ipsam-mollitia-eveniet-hic/"
          },
          "171": {
             "title": "Sint aperiam autem molestiae debitis",
             "slug": "sint-aperiam-autem-molestiae-debitis",
             "link": "http://demo.wp-api.org/2015/08/12/sint-aperiam-autem-molestiae-debitis/"
          }
       }
    }

    Going deeper: postsById[131].terms.category[0].name

    {
       "postsById": {
          "131": {
             "terms": {
                "category": {
                   "0": {
                      "name": "Illum in fugit assumenda quo et reprehenderit maxime saepe"
                   }
                }
             }
          }
       }
    }

    recentPosts

    Basic example: recentPosts[0..2].title

    {
       "recentPosts": {
          "0": {
             "title": "Repellat dolor architecto inventore"
          },
          "1": {
             "title": "Dolor adipisci soluta eum ipsam deserunt"
          },
          "2": {
             "title": "Ipsam mollitia eveniet hic"
          }
       }
    }

    Going deeper: recentPosts[5].terms.category[0].name

    {
       "recentPosts": {
          "5": {
             "terms": {
                "category": {
                   "0": {
                      "name": "In fugit quae libero a"
                   }
                }
             }
          }
       }
    }

    postsByTerm[vocabulary][term-slug]

    Example: postsByTerm.category.tool-kit[0..3]['title','id']

    {
      "postsByTerm": {
        "category": {
           "tool-kit": {
              "0": {
                 "title": "Writing Reports, Quick Guide",
                 "id": 97
              },
              "1": {
                 "title": "Analyzing Data, Quick Guide",
                 "id": 95
              },
              "2": {
                 "title": "Measuring Outcomes, Quick Guide",
                 "id": 92
              },
              "3": {
                 "title": "Creating Learning Outcomes, Quick Guide",
                 "id": 90
              }
           }
        }
      }
    }

    termsById[vocabulary]

    Categories example: termsById.category[4,70]['name','description']

    {
       "termsById": {
          "category": {
             "4": {
                "name": "Ab iusto",
                "description": "Sunt distinctio asperiores dolores quae odit necessitatibus dolor dolore quo doloremque nam incidunt molestiae facilis quisquam voluptatem voluptas et voluptas sapiente laudantium fugiat"
             },
             "70": {
                "name": "Accusantium nulla omnis quos",
                "description": "Occaecati placeat et dolores tempore unde est laudantium ipsam tempora accusamus culpa sequi aut aut dolore minus pariatur fugit ut ipsa et distinctio minus amet ut id molestiae assumenda aliquam vel qui quibusdam"
             }
          }
       }
    }

    Tags example: termsById.tag[36]['slug','name']

    {
       "termsById": {
          "tag": {
             "36": {
                "slug": "accusantium-dolore-porro-nihil-eveniet-dolores-impedit-quisquam",
                "name": "Accusantium dolore porro nihil eveniet dolores impedit quisquam"
             }
          }
       }
    }

    taxonomies

    Metadata: taxonomies.category.meta['name','slug']

    {
       "taxonomies": {
          "category": {
             "meta": {
                "name": "Categories",
                "slug": "category"
             }
          }
       }
    }

    Number of available terms: taxonomies.category.terms.length

    {
       "taxonomies": {
          "category": {
             "terms": {
                "length": "52"
             }
          }
       }
    }

    Terms range: taxonomies.tag.terms[0..2]['name']

    {
       "taxonomies": {
          "tag": {
             "terms": {
                "0": {
                   "name": "Accusantium dolore porro nihil eveniet dolores impedit quisquam"
                },
                "1": {
                   "name": "Ad et modi ipsam in iure"
                },
                "2": {
                   "name": "Adipisci ut tempora quisquam"
                }
             }
          }
       }
    }

    Other routes

    These are also available at root, though generally more useful where referenced elsewhere:

    authorsById mediaById

    Media linked as featured image: postsById[131].featured_image.media_details.sizes.thumbnail.file

    {
       "postsById": {
          "131": {
             "featured_image": {
                "media_details": {
                   "sizes": {
                      "thumbnail": {
                         "file": "fba2be87-deae-3077-96b4-d1754a1802ca-150x150.jpg"
                      }
                   }
                }
             }
          }
       }
    }

    Author of a post: postsById[171].author.name

    {
       "postsById": {
          "171": {
             "author": {
                "name": "Cassidy"
             }
          }
       }
    }

    Roadmap

    • postsById
    • recentPosts
    • taxonomies (meta, terms list)
    • termsById
    • authorsById
    • mediaById
    • posts by term
    • more linked subqueries
    • additional listings by varied sorts

    Keywords

    none

    Install

    npm i falcor-wordpress

    DownloadsWeekly Downloads

    4

    Version

    0.3.0

    License

    none

    Last publish

    Collaborators

    • avatar