https://github.com/ryanhefner/apollo-link-contentful

🔗 An ApolloLink that lets you perform GraphQL queries against Contentful’s Rest API. No more, query size limits! No more, query complexities!!
https://github.com/ryanhefner/apollo-link-contentful

apollo apollo-link contentful contentful-api contentful-js-sdk

Last synced: 5 days ago
JSON representation

🔗 An ApolloLink that lets you perform GraphQL queries against Contentful’s Rest API. No more, query size limits! No more, query complexities!!

• Host: GitHub
• URL: https://github.com/ryanhefner/apollo-link-contentful
• Owner: ryanhefner
• License: mit
• Created: 2020-09-10T12:15:13.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2023-07-13T13:15:53.000Z (about 1 year ago)
• Last Synced: 2024-09-25T03:04:48.024Z (8 days ago)
• Topics: apollo, apollo-link, contentful, contentful-api, contentful-js-sdk
• Language: JavaScript
• Homepage: https://www.pkgstats.com/pkg:apollo-link-contentful
• Size: 549 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 🔗 apollo-link-contentful

[![npm](https://img.shields.io/npm/v/apollo-link-contentful?style=flat-square)](https://www.pkgstats.com/pkg:apollo-link-contentful)

[![NPM](https://img.shields.io/npm/l/apollo-link-contentful?style=flat-square)](https://www.pkgstats.com/pkg:apollo-link-contentful)

[![npm](https://img.shields.io/npm/dt/apollo-link-contentful?style=flat-square)](https://www.pkgstats.com/pkg:apollo-link-contentful)

[![Coveralls github](https://img.shields.io/coveralls/github/ryanhefner/apollo-link-contentful?style=flat-square)](https://coveralls.io/github/ryanhefner/apollo-link-contentful)

![CircleCI](https://img.shields.io/circleci/build/github/ryanhefner/apollo-link-contentful?style=flat-square)

> 🚨 very alpha! in active development. 🚨

> All minor version changes (0.X.0) are likely to have breaking changes.

Perform GraphQL queries against Contentful’s Rest API. No more, query size limits! No more, query complexities!!

## Install

Via [npm](https://npmjs.com/package/apollo-link-contentful)

```sh

npm install --save apollo-link-contentful

```

Via [Yarn](https://yarn.fyi/apollo-link-contentful)

```sh

yarn add apollo-link-contentful

```

## How to use

`ContentfulRestLink` makes it easy to query the Contentful REST API via GraphQL +

Apollo, without all the fuss about query size, nor complexity, limit issues. Simply

setup the `link` when you are creating your `ApolloClient`, then feel free to

perform your `GraphQL` queries like you normally do.

The `ContentfulRestLink` class accepts two arguments, `clientOptions` and `queryDefaults` _(optional)_.

* `clientOptions` - Accepts all Contentful Client options, reference available [here](https://contentful.github.io/contentful.js/contentful/7.14.6/contentful.html#.createClient).

_The only exception is that if you plan to use the Contentful Preview API, you’ll have to include an optional `previewAccessToken`, which will create a client for all queries where `preview` variable is `true`._

* `queryDefaults` - This is just a handy tool if you happen to have some defaults

that you would like to include for all queries being made to Contentful. Handy ones

that you might use would be, `{ include: 10, locale: 'en-US' }`. Where `include` sets

the depth of linked references to include in responses, [Link docs](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/links),

and `locale` specifies the localization of the entry(ies) returned, [Localization docs](https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/localization).

## Example

```js

import { ApolloClient, InMemoryCache } from '@apollo/client'

import { ContentfulRestLink } from 'apollo-link-contentful'

import possibleTypes from 'types/possibleTypes.json'

const space = process.env.CONTENTFUL_SPACE

const accessToken = process.env.CONTENTFUL_ACCESS_TOKEN

const apolloClient = new ApolloClient({

  link: new ContentfulRestLink({

    space,

    accessToken,

  }, {

    include: 10,

  }),

  cache: new InMemoryCache({ possibleTypes }),

});

```

## License

[MIT](LICENSE) © [Ryan Hefner](https://www.ryanhefner.com)