Connecting to GraphQL using Apollo Client

November 14, 2023

Connecting to GraphQL using Apollo Client

To connect to Jahia's GraphQL API, you can add the Apollo GraphQL client library.

To add the Apollo GraphQL client library:

  1. From the root of the project, execute the following commands on the command line:
    yarn add react-apollo
    yarn add apollo-cache-inmemory
    yarn add apollo-client
    yarn add apollo-client-preset
    yarn add apollo-link-rest
    yarn add graphql
  2. In App.js file add:
    import {ApolloProvider} from 'react-apollo';
    import {ApolloClient} from 'apollo-client';
    import {HttpLink} from 'apollo-link-http';
    import {InMemoryCache} from 'apollo-cache-inmemory';
    const JWTDXToken = 'JWT_DX_TOKEN';
    const httpLink = new HttpLink({
        uri: 'http://localhost:8080/modules/graphql',
        headers: {
            'Authorization': `Bearer ${JWTDXToken}`
    const client = new ApolloClient({
        link: httpLink,
        cache: new InMemoryCache()
  3. Then modify the render body to the following:
        <ApolloProvider client={client}>
            <AppBar position="static" color="default">
                    <Typography variant="title" color="inherit">
            <Grid container>
                <Grid item xs={12}>
  4. Next you create a container for the CompanyList component that will fetch company data using GraphQL. Create a ContainerList.container.jsx in src/components/CompanyList and add the following imports:
    import React from 'react';
    import {Query} from "react-apollo";
    import gql from 'graphql-tag';
    import CompanyList from './CompanyList';
  5. You can now declare a query for retrieving all available companies:
    const COMPANIES_QUERY = gql`
        query CompaniesListQuery($language: String) {
            jcr(workspace:LIVE) {
                nodesByQuery(query: "SELECT * FROM [jdnt:company] as results WHERE ISDESCENDANTNODE(results, '/sites/digitall/')", queryLanguage:SQL2) {
                    nodes {
                        title: displayName(language : $language)
                        description : property(name : "overview", language : $language) {
                        thumbnail : property(name : "thumbnail", language : $language) {
                            url: refNode {
  6. Next you define the functional CompanyListContainer component that uses the previously imported Query component to fetch and render the CompanyList:
    const CompanyListContainer = () => {
        const variables = {
            language: "en"
        const generateURL = path => {
            return `http://localhost:8080/files/live${path}?t=thumbnail2`;
        return (
            <Query query={COMPANIES_QUERY} variables={variables} fetchPolicy="network-only">
                {({loading, data}) => {
                    let companies = [];
                    if (data && data.jcr && data.jcr.nodesByQuery) {
                        //Build the company data as expected by the Company component
                        data.jcr.nodesByQuery.nodes.forEach(node => {
                                id: node.uuid,
                                title: node.title,
                                description: node.description.value,
                                image: generateURL(node.thumbnail.url.path)
                    return <CompanyList loading={loading}
    export default CompanyListContainer;
  7. Update the existing index.js so that CompanyListContainer is the default export. Change:
    import CompanyList from './CompanyList';
    import CompanyList from './CompanyList.container';
  8. Lastly, you update the Company component to make data displays dynamically. Change:
        <Typography component="h1" variant="display1">
            Company Name
        <Typography component="p">
            {description.length > 150 ? `${description.substr(0,100)}...` : description}
        <Typography variant="title">
        <Typography component="div">
            <p dangerouslySetInnerHTML={{__html: description.length > 150 ? `${description.substr(0, 100)}...` : description}}/>
    You now have a base Javascript application that retrieves content from Jahia using GraphQL and that uses React and React Material to display the content.

Setting up authorization

By default, Jahia’s REST and GraphQL API are closed even if nodes have public read permissions. The APIs are closed for security reasons. To open up the API and make it usable for your application, you must configure Jahia’s security filter module to allow public access. You can find more information about the security filter module here:

Note: Developer Tools requires the appropriate permissions. For more information on required permissions, see Managing roles and permissions.

To make the data publicly accessible:

  1. Add the org.jahia.modules.api.permissions-myapp.cfg Jahia configuration file to the digital-factory-data/karaf/etc folder with the following contents:
    The scope setup here requires creating a JWT token when you integrate authorization in the Apollo Client in the Javascript code. Please be aware that the value of permission.myapp.pathPattern here. It should match the node paths which you are going to access.
  2. You also must create a org.jahia.modules.graphql.provider-myapp.cfg file for the CORS authorization with the following content:
  3. In Jahia, navigate to Developer Tools>JWT Configuration and create a new JWT Token. Click the Add token button and specifies myapp in Scopes in the Edit Token Parameters dialog.
  4. Click Save and copy the generated token.
  5. Replace the example JWT_DX_TOKEN value with the copied token.