• Getting Started
  • Developer Guides
  • Optional features
    • Advanced Workflow
    • Elemental blocks
    • Content Localisation with Fluent
    • GraphQL
      • Getting started
        • Server Requirements
        • Activating the default server
        • Configuring your schema
        • Building the schema
        • Building a schema with procedural code
        • Deploying the schema
      • Working with DataObject models
      • Working with generic types
      • Security & best practices
      • Plugins
      • Extending the schema
      • Tips & Tricks
      • Architecture Diagrams
    • GridField Bulk Editing Tools
    • GridField Extensions
    • TinyMCE HTML editor
    • Linkfield
    • Login forms
    • Multi-factor authentication (MFA)
    • Queued Jobs
    • RealMe
    • Static Publish Queue
    • TagField
    • Taxonomies
    • Text Extraction
    • TOTP Authenticator
    • UserForms
  • Upgrading
  • Changelogs
  • Contributing
  • Project Governance
  1. Optional features
  2. GraphQL
  3. Getting started
Version 6Supported

Getting started#

This section of the documentation will give you an overview of how to get a simple GraphQL API up and running with some DataObject content.

Server Requirements

What you will need to run GraphQL on a web server

Activating the default server

Open up the default server that comes pre-configured with the module

Configuring your schema

Add a basic type to the schema configuration

Building the schema

Turn your schema configuration into executable code

Building a schema with procedural code

Use PHP code to build your schema

Deploying the schema

Deploy your GraphQL schema to a test or production environment

Edit on GitHub