Skip to content

Latest commit

 

History

History

README.md

Yelp GraphQL Query Generator

Generates random GraphQL queries for the Yelp API.

Usage

Clone the example library.

Install the dependencies.

npm ci

The query generator dynamically creates providers by querying the Yelp API for data. In order to do so, you must provide your Yelp credentials.

Create a file named .env with your Yelp API key.

YELP_ACCESS_TOKEN={your API key}

The following JavaScript code, when executed from the current directory, uses the getYelpQueryGenerator() factory method to create a YelpQueryGenerator object, which can be used to generate queries.

require("dotenv").config()

const { getYelpQueryGenerator } = require("./lib/index")
const { print } = require("graphql")

getYelpQueryGenerator(process.env.YELP_ACCESS_TOKEN).then((queryGenerator) => {
  const query = queryGenerator.generateRandomYelpQuery()
  const { queryDocument, variableValues } = query

  console.log(print(queryDocument))
  console.log(JSON.stringify(variableValues, null, 2))
})

Generating a query corpus

We provided a script that can generate a corpus of 5,000 randomly generated Yelp queries and responses.

To create the corpus, please provide your Yelp access token in a .env file, as described in the previous section.

Then, run:

npm run generate-corpus

The corpus will be saved into the query-corpus/ folder.

Disclaimer

Queries are associated with a particular version of a GraphQL schema. Due to the natural evolution of the Yelp API, the generated queries may not work with the current version of the API. The generated queries may contain deprecated fields and the new API may require new arguments for certain fields. However, the generated queries are valid and would have worked with the version of the API at the time.