@gridsome/source-graphql
v0.1.0
Published
GraphQL source for Gridsome
Downloads
1,238
Maintainers
Readme
@gridsome/source-graphql
Pull a remote GraphQL schema in locally
Install
yarn add @gridsome/source-graphql
npm install @gridsome/source-graphql
Usage
module.exports = {
plugins: [
{
use: '@gridsome/source-graphql',
options: {
url: 'https://example.com/api',
fieldName: 'puppies',
typeName: 'puppyTypes',
headers: {
Authorization: `Bearer ${process.env.AUTH_TOKEN}`,
},
},
},
],
}
Options
url
- Type:
string
required
The URL of a GraphQL API endpoint to request your schema from.
fieldName
- Type:
string
required
The name that should be used to namespace your remote schema when it's merged in, so that it doesn't conflict with any local data.
For instance, if you put "puppies" your remote schema's data will be available by querying like so:
query {
puppies {
helloWorld
}
}
typeName
- Type:
string
- Defaults:
fieldName
The prefix to be used for your imported schema's field types.
headers
- Type:
object
An object of headers to be passed along with your request to the API endpoint. This will generally be used to authenticate your request.
Note: For safety, you should pass any sensitive tokens/passwords as environmental variables. To learn more, see the Gridsome Docs on Environmental Variables.