mirror of
https://github.com/Fechin/reference.git
synced 2026-11-20 21:23:11 +03:00
Added GraphQL cheatsheet
This commit is contained in:
1 parent
2042cb9aef
commit
1bbdaa8046
1 file changed
+206
+206
@@ -0,0 +1,206 @@
|
||||
---
|
||||
title: GraphQL
|
||||
date: 2021-07-15 20:51:44
|
||||
icon: icon-graphql
|
||||
background: bg-pink-600
|
||||
tags:
|
||||
- query
|
||||
- API
|
||||
categories:
|
||||
- Programming
|
||||
intro: |
|
||||
This quick reference cheat sheet provides a brief overview of GraphQL.
|
||||
---
|
||||
|
||||
|
||||
Getting started {.cols-3}
|
||||
--------
|
||||
|
||||
### Overview
|
||||
|
||||
- An alternative approach to RESTful APIs
|
||||
- GraphQL is a query language for APIs
|
||||
- Easily describe the shape of the GraphQL API using clear shared terms.
|
||||
- Clients issue queries/mutations to read and update data
|
||||
- GraphQL syntax can express complex entity relations
|
||||
- Libraries to implement GraphQL in [different languages](https://graphql.org/code/)
|
||||
|
||||
[GraphQL](https://graphql.org/)
|
||||
{.link-arrow}
|
||||
|
||||
|
||||
### Schema
|
||||
|
||||
| | |
|
||||
|---------------|-----------------------------------------|
|
||||
| `schema` | GraphQL schema definition |
|
||||
| `query` | Read and traverse data |
|
||||
| `mutation` | Modify data or trigger an action |
|
||||
| `subscription`| Run a query when an event occurs |
|
||||
|
||||
|
||||
|
||||
### Built-in Scalar Types
|
||||
|
||||
| | |
|
||||
|-----------|---------|
|
||||
| `Int` | Signed 32‐bit integer |
|
||||
| `Float` | Signed double-precision floating-point value |
|
||||
| `String` | UTF‐8 character sequence |
|
||||
| `Boolean` | true or false |
|
||||
| `ID` | A Unique identifier |
|
||||
|
||||
|
||||
|
||||
### Type Definitions
|
||||
|
||||
| | |
|
||||
|-------------|-------------------|
|
||||
| `scalar` | Scalar Type |
|
||||
| `type` | Object Type |
|
||||
| `interface` | Interface Type |
|
||||
| `union` | Union Type |
|
||||
| `enum` | Enum Type |
|
||||
| `input` | Input Object Type |
|
||||
|
||||
|
||||
|
||||
### Type Modifiers
|
||||
|
||||
| | |
|
||||
|--------------|-----------------------------------|
|
||||
| `String` | Nullable String |
|
||||
| `String!` | Non-null String |
|
||||
| `[String]` | List of nullable Strings |
|
||||
| `[String]!` | Non-null list of nullable Strings |
|
||||
| `[String!]!` | Non-null list of non-null Strings |
|
||||
|
||||
|
||||
### Input Arguments {.row-span-2}
|
||||
#### Basic Input
|
||||
```js
|
||||
type Query {
|
||||
users(limit: Int): [User]
|
||||
}
|
||||
```
|
||||
|
||||
#### Input with default value
|
||||
```js
|
||||
type Query {
|
||||
users(limit: Int = 10): [User]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### Input with multiple arguments
|
||||
```js
|
||||
type Query {
|
||||
users(limit: Int, sort: String): [User]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
#### Input with multiple arguments and default values
|
||||
|
||||
```js {.wrap}
|
||||
type Query {
|
||||
users(limit: Int = 10, sort: String): [User]
|
||||
}
|
||||
type Query {
|
||||
users(limit: Int, sort: String = "asc"): [User]
|
||||
}
|
||||
type Query {
|
||||
users(limit: Int = 10, sort: String = "asc"): [User]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Input Types
|
||||
|
||||
|
||||
```js
|
||||
input ListUsersInput {
|
||||
limit: Int
|
||||
since_id: ID
|
||||
}
|
||||
```
|
||||
|
||||
```js
|
||||
type Mutation {
|
||||
users(params: ListUsersInput): [User]!
|
||||
}
|
||||
```
|
||||
|
||||
### Custom Scalars
|
||||
|
||||
|
||||
```js
|
||||
scalar Url
|
||||
type User {
|
||||
name: String
|
||||
homepage: Url
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Interfaces
|
||||
|
||||
```js
|
||||
interface Foo {
|
||||
is_foo: Boolean
|
||||
}
|
||||
interface Goo {
|
||||
is_goo: Boolean
|
||||
}
|
||||
type Bar implements Foo {
|
||||
is_foo: Boolean
|
||||
is_bar: Boolean
|
||||
}
|
||||
type Baz implements Foo, Goo {
|
||||
is_foo: Boolean
|
||||
is_goo: Boolean
|
||||
is_baz: Boolean
|
||||
}
|
||||
```
|
||||
Object implementing one or more Interfaces
|
||||
|
||||
|
||||
### Unions
|
||||
|
||||
```js
|
||||
type Foo {
|
||||
name: String
|
||||
}
|
||||
type Bar {
|
||||
is_bar: String
|
||||
}
|
||||
union SingleUnion = Foo
|
||||
union MultipleUnion = Foo | Bar
|
||||
type Root {
|
||||
single: SingleUnion
|
||||
multiple: MultipleUnion
|
||||
}
|
||||
```
|
||||
Union of one or more Objects
|
||||
|
||||
|
||||
### Enums
|
||||
|
||||
```js {.wrap}
|
||||
enum USER_STATE {
|
||||
NOT_FOUND
|
||||
ACTIVE
|
||||
INACTIVE
|
||||
SUSPENDED
|
||||
}
|
||||
type Root {
|
||||
stateForUser(userID: ID!): USER_STATE!
|
||||
users(state: USER_STATE, limit: Int = 10): [User]
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
|
||||
Also see
|
||||
-------
|
||||
* [GraphQL Schema Language Cheat Sheet](https://github.com/sogko/graphql-schema-language-cheat-sheet) _(github.com)_
|
||||
Reference in new issue
Block a user