mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-18 23:46:21 +02:00
c1cda2b113
* DOCS: Add new graphql 4 docs * Reorganise docs * Docs done * Basic graphql index page * TOC for getting started * show folders on graphql index page * Add middleware note * Docs update * Update docs to reflect flushless schema * Docs updates * Docs for getByLink * Query caching docs * Docs on nested operations * update docs for new graphql dev admin * Docs for configurable operations * Replace readSiteTrees with readPages * Schema defaults docs * Docs for inherited plugins * Docs for customising * * Docs for field whitelisting * Change whitelist word * New docs on modelConfig * Document dev/build extension * Document default/global plugins * Document new input type fields config * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * Note about when procedural schema gets built * Fix link * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * DOCS Note about plugins in custom queries * DOCS Note about filter and custom resolvers * DOCS Note about canview paging * DOCS Updated guidance on _extend See https://github.com/silverstripe/silverstripe-graphql/issues/296 * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * DOCS Pre-release warning Co-authored-by: Ingo Schommer <ingo@silverstripe.com> Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> Co-authored-by: Ingo Schommer <me@chillu.com>
79 lines
2.6 KiB
Markdown
79 lines
2.6 KiB
Markdown
---
|
|
title: Activating the default server
|
|
summary: Open up the default server that comes pre-configured with the module
|
|
icon: rocket
|
|
---
|
|
|
|
# Getting started
|
|
|
|
[CHILDREN asList]
|
|
|
|
[alert]
|
|
You are viewing docs for a pre-release version of silverstripe/graphql (4.x).
|
|
Help us improve it by joining #graphql on the [Community Slack](https://www.silverstripe.org/blog/community-slack-channel/),
|
|
and report any issues at [github.com/silverstripe/silverstripe-graphql](https://github.com/silverstripe/silverstripe-graphql).
|
|
Docs for the current stable version (3.x) can be found
|
|
[here](https://github.com/silverstripe/silverstripe-graphql/tree/3)
|
|
[/alert]
|
|
|
|
## Activating the default GraphQL server
|
|
|
|
GraphQL is used through a single route, typically `/graphql`. You need
|
|
to define *types* and *queries* to expose your data via this endpoint. While this recommended
|
|
route is left open for you to configure on your own, the modules contained in the [CMS recipe](https://github.com/silverstripe/recipe-cms),
|
|
(e.g. `asset-admin`) run off a separate GraphQL server with its own endpoint
|
|
(`admin/graphql`) with its own permissions and schema.
|
|
|
|
These separate endpoints have their own identifiers. `default` refers to the GraphQL server
|
|
in the user space (e.g. `/graphql`) while `admin` refers to the GraphQL server used by CMS modules
|
|
(`admin/graphql`). You can also [set up a new schema](#setting-up-a-custom-graphql-server) if you wish.
|
|
|
|
By default, this module does not route any GraphQL servers. To activate the default,
|
|
public-facing GraphQL server that ships with the module, just add a rule to `Director`.
|
|
|
|
```yaml
|
|
SilverStripe\Control\Director:
|
|
rules:
|
|
'graphql': '%$SilverStripe\GraphQL\Controller.default'
|
|
```
|
|
|
|
## Setting up a custom GraphQL server
|
|
|
|
In addition to the default `/graphql` endpoint provided by this module by default,
|
|
along with the `admin/graphql` endpoint provided by the CMS modules (if they're installed),
|
|
you may want to set up another GraphQL server running on the same installation of SilverStripe.
|
|
|
|
Let's set up a new controller to handle the requests.
|
|
|
|
```yaml
|
|
SilverStripe\Core\Injector\Injector:
|
|
# ...
|
|
SilverStripe\GraphQL\Controller.myNewSchema:
|
|
class: SilverStripe\GraphQL\Controller
|
|
constructor:
|
|
schemaKey: myNewSchema
|
|
|
|
```
|
|
|
|
|
|
We'll now need to route the controller.
|
|
|
|
```yaml
|
|
SilverStripe\Control\Director:
|
|
rules:
|
|
'my-graphql': '%$SilverStripe\GraphQL\Controller.myNewSchema'
|
|
```
|
|
|
|
Now, you're ready to [configure your schema](configuring_your_schema.md).
|
|
|
|
```yaml
|
|
SilverStripe\GraphQL\Schema\Schema:
|
|
schemas:
|
|
myNewSchema:
|
|
# ...
|
|
```
|
|
|
|
### Further reading
|
|
|
|
[CHILDREN]
|