• Getting Started
  • Developer Guides
  • Optional features
    • Advanced Workflow
    • Elemental blocks
    • Content Localisation with Fluent
    • GraphQL
      • Getting started
      • 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
Version 6Supported

Silverstripe CMS GraphQL server#

On this page

  • Installation
  • GitHub repository

GraphQL can be used as a content API layer for Silverstripe CMS to get data in and out of the content management system.

For more information on GraphQL in general, visit its documentation site.

Installation#

bash
composer require silverstripe/graphql

GitHub repository#

https://github.com/silverstripe/silverstripe-graphql

Getting started

Open up your first GraphQL server and build your schema

Working with DataObject models

Add DataObject models to your schema, expose their fields, add read/write operations, and more

Working with generic types

Break away from the magic of DataObject models and build types and queries from scratch.

Security & best practices

A guide to keeping your GraphQL API secure and accessible

Plugins

Learn what plugins are and how you can use them to extend your schema

Extending the schema

Add new functionality to the schema

Tips & Tricks

Miscellaneous useful tips for working with your GraphQL schema

Architecture Diagrams

A visual overview of the architecture and design of silverstripe/graphql

Edit on GitHub