cailongHuang / wp-graphql

A GraphQL endpoint for WordPress

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

WPGraphQL Build Status Coverage Status

GraphQL API for WordPress.

##Installing Install the plugin like any WP Plugin, then flush your permalinks.

##Overview This plugin brings the power of GraphQL to WordPress.

GraphQL is a query language spec that was open sourced by Facebook® in 2015, and has been used in production by Facebook® since 2012.

GraphQL has some similarities to REST in that it exposes an HTTP endpoint where requests can be sent and a JSON response is returned. However, where REST has a different endpoint per resource, GraphQL has just a single endpoint and the data returned isn't implicit, but rather explicit and matches the shape of the request.

A REST API is implicit, meaning that the data coming back from an endpoint is implied. An endpoint such as /Posts/ implies that the data I will retrieve is data related to Post objects, but beyond that it's hard to know exactly what will be returned. It might be more data than I need or might not be the data I need at all.

GraphQL is explicit, meaning that you ask for the data you want and you get the data back in the same shape that it was asked for.

Additionally, where REST requires multiple HTTP requests for related data, GraphQL allows related data to be queried and retrieved in a single request, and again, in the same shape of the request without any worry of over or under-fetching data.

GraphiQL API Explorer

GraphiQL is a fantastic GraphQL API Explorer / IDE. There are various versions of GraphiQL that you can find, including a Chrome Extension but my recommendation is the GraphiQL desktop app below:

  • Download the GraphiQL Desktop App

    • Once the app is downloaded and installed, open the App.
    • Set the GraphQL Endpoint to http://yoursite.com/graphql
    • You should now be able to browse the GraphQL Schema via the "Docs" explorer at the top right.
    • On the left side, you can execute GraphQL Queries
    GraphiQL API Explorer

About

A GraphQL endpoint for WordPress


Languages

Language:PHP 98.3%Language:Shell 1.7%