React Templates & Themes Logo React Templates & Themes
Contentful Graphql Playground App screenshot

Contentful Graphql Playground App

Author Avatar Theme by Contentful
Updated: 16 Apr 2024
22 Stars

Contentful App to integrate GraphQL Playground

Github

Overview:

The Contentful GraphQL Playground App is a Contentful App that allows users to query Contentful’s GraphQL API using GraphQL Playground directly within the Contentful web interface. This app provides a more convenient way for developers to interact with the GraphQL API and test their queries.

Features:

  • GraphQL Playground Integration: Access GraphQL Playground directly within the Contentful web interface.
  • Easy Installation: Can be installed from the Contentful Marketplace with just a few clicks.
  • Custom Functionality: Extends the Contentful UI with additional functionality for querying the GraphQL API.
  • Multiple Integration Points: Supports integration with the App configuration screen, Entry sidebar, and full-page app.

Installation:

To install the Contentful GraphQL Playground App, follow these steps:

  1. Open the Contentful Marketplace and locate the Contentful GraphQL Playground App.
  2. Click on “Install now” to install the app.
  3. Alternatively, for development purposes, you can manually set up the app by creating a new app in your organization settings.
  4. Define the preferred application name and provide the following App URL: https://contentful-graphql-playground-app.netlify.app.
  5. Specify the desired locations in the Contentful UI where the app should be available.
    • (Required) App configuration screen (app-config): Configure the GraphQL playground app.
    • (Optional) Entry sidebar (entry-sidebar): Open GraphQL playground from the entry editor sidebar.
    • (Optional) Page (page): Use GraphQL playground as a full-page app.
  6. Enable the App configuration screen to configure the application.
  7. Install the app into your preferred space.
  8. Create and define a CPA (Content Preview API) token and save the configuration.
  9. Follow the instructions within the app configuration screen to enable the app for the entry sidebar.

Summary:

The Contentful GraphQL Playground App is a useful tool for developers working with Contentful’s GraphQL API. With its integration into the Contentful UI, developers can easily access and test GraphQL queries without leaving the web interface. The app can be installed directly from the Contentful Marketplace or manually set up for development purposes. It provides a range of integration points within the Contentful UI and allows for custom configuration.