b383eb65c6
* feat: autolabel fields when omitted * feat: handle autolabel in graphql mutation build * feat: autolabel blocks * test: add required slug field to blocks * feat: handle graphql names when label is false * feat: adds relationship field to test searchable input * feat: handle block cell type labeling pluralization * docs: remove all explicit labeling, no longer needed * fix: falsey column labels, allows false array labels * fix: client tests * fix: auto-labels globals * docs: globals auto-labeling and hooks clarification * fix; proper object type naming Co-authored-by: James <james@trbl.design>
95 lines
3.6 KiB
Plaintext
95 lines
3.6 KiB
Plaintext
---
|
|
title: GraphQL Overview
|
|
label: Overview
|
|
order: 10
|
|
desc: Payload ships with a fully featured and extensible GraphQL API, which can be used in addition to the REST and Local APIs to give you more flexibility.
|
|
keywords: graphql, resolvers, mutations, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
|
|
---
|
|
|
|
In addition to its REST and Local APIs, Payload ships with a fully featured and extensible GraphQL API.
|
|
|
|
By default, the GraphQL API is exposed via `/api/graphql`, but you can customize this URL via specifying your `routes` within the main Payload config.
|
|
|
|
The labels you provide for your Collections and Globals are used to name the GraphQL types that are created to correspond to your config. Special characters and spaces are removed.
|
|
|
|
### Collections
|
|
|
|
Everything that can be done to a Collection via the REST or Local API can be done with GraphQL (outside of uploading files, which is REST-only). If you have a collection as follows:
|
|
|
|
```js
|
|
const PublicUser = {
|
|
slug: 'public-users',
|
|
auth: true, // Auth is enabled
|
|
labels: {
|
|
singular: 'Public User',
|
|
plural: 'Public Users',
|
|
},
|
|
fields: [
|
|
...
|
|
],
|
|
}
|
|
```
|
|
|
|
**Payload will automatically open up the following queries:**
|
|
|
|
| Query Name | Operation |
|
|
| ---------------------- | -------------|
|
|
| **`PublicUser`** | `findByID` |
|
|
| **`PublicUsers`** | `find` |
|
|
| **`mePublicUser`** | `me` auth operation |
|
|
|
|
**And the following mutations:**
|
|
|
|
| Query Name | Operation |
|
|
| ------------------------------ | -------------|
|
|
| **`createPublicUser`** | `create` |
|
|
| **`updatePublicUser`** | `update` |
|
|
| **`deletePublicUser`** | `delete` |
|
|
| **`forgotPasswordPublicUser`** | `forgotPassword` auth operation |
|
|
| **`resetPasswordPublicUser`** | `resetPassword` auth operation |
|
|
| **`unlockPublicUser`** | `unlock` auth operation |
|
|
| **`verifyPublicUser`** | `verify` auth operation |
|
|
| **`loginPublicUser`** | `login` auth operation |
|
|
| **`logoutPublicUser`** | `logout` auth operation |
|
|
| **`refreshTokenPublicUser`** | `refresh` auth operation |
|
|
|
|
### Globals
|
|
|
|
Globals are also fully supported. For example:
|
|
|
|
```js
|
|
const Header = {
|
|
slug: 'header',
|
|
fields: [
|
|
...
|
|
],
|
|
}
|
|
```
|
|
|
|
**Payload will open the following query:**
|
|
|
|
| Query Name | Operation |
|
|
| ---------------------- | -------------|
|
|
| **`Header`** | `findOne` |
|
|
|
|
**And the following mutation:**
|
|
|
|
| Query Name | Operation |
|
|
| ---------------------- | -------------|
|
|
| **`updateHeader`** | `update` |
|
|
|
|
### GraphQL Playground
|
|
|
|
GraphQL Playground is enabled by default for development purposes, but disabled in production. You can enable it in production by passing `graphQL.disablePlaygroundInProduction` a `false` setting in the main Payload config.
|
|
|
|
You can even log in using the `login[collection-singular-label-here]` mutation to use the Playground as an authenticated user.
|
|
|
|
<Banner type="success">
|
|
<strong>Tip:</strong><br/>
|
|
To see more regarding how the above queries and mutations are used, visit your GraphQL playground (by default at <a href="http://localhost:3000/api/graphql-playground">(http://localhost:3000/api/graphql-playground)</a> while your server is running. There, you can use the "Schema" and "Docs" buttons on the right to see a ton of detail about how GraphQL operates within Payload.
|
|
</Banner>
|
|
|
|
### Query complexity limits
|
|
|
|
Payload comes with a built-in query complexity limiter to prevent bad people from trying to slow down your server by running massive queries. To learn more, [click here](/docs/production/preventing-abuse#limiting-graphql-complexity).
|