• Getting Started
  • Lessons
  • Developer Guides
    • Model and Databases
    • Templates and Views
    • Controllers
    • Forms
    • Configuration
    • Extending Silverstripe CMS
    • Testing
    • Debugging
    • Performance
    • Security
    • Email
    • Integration and Web Services
    • Search
    • i18n
    • Files
    • Customising the Admin Interface
    • Execution pipeline
    • Command Line Interface
    • Cookies and Sessions
    • Graphql
      • Getting started
      • Working with DataObject models
      • Working with generic types
      • Security & best practices
      • Plugins
      • Extending the schema
      • Tips & Tricks
      • Architecture Diagrams
    • Deprecating code
  • Optional features
  • Upgrading
  • Changelogs
  • Contributing
  • Project Governance
  1. Developer Guides
  2. Graphql
Version 5Supported

This version of Silverstripe CMS is still supported though will not receive any additional features.

Go to documentation for the most recent stable version

Silverstripe CMS GraphQL server#

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

CAUTION

GraphQL is being removed from the admin section in CMS 6.0, so any customisations made to the admin schema will no longer work. GraphQL will still be available as an optional module in CMS 6.0 and still be used to create frontend schemas i.e. the default schema.

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

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