|
1 | | ---- |
2 | | -sidebarTitle: Introduction |
3 | | ---- |
| 1 | +import { Cards } from '../../components/cards' |
4 | 2 |
|
5 | 3 | # GraphQL Best Practices |
6 | 4 |
|
7 | 5 | The GraphQL specification is intentionally silent on a handful of important issues facing APIs such as dealing with the network, authorization, and pagination. This doesn't mean that there aren't solutions for these issues when using GraphQL, just that they're outside the description about what GraphQL _is_ and instead just common practice. |
8 | 6 |
|
9 | 7 | The articles in this section should not be taken as gospel, and in some cases may rightfully be ignored in favor of some other approach. Some articles introduce some of the philosophy developed within Facebook around designing and deploying GraphQL services, while others are more tactical suggestions for solving common problems like serving over HTTP and performing authorization. |
10 | 8 |
|
11 | | -Following are brief descriptions of some of the more common best practices and opinionated stances held by GraphQL services, however each article in this section will go into more depth on these and other topics. |
12 | | - |
13 | | -## HTTP |
14 | | - |
15 | | -GraphQL is typically served over HTTP via a single endpoint which expresses the full set of capabilities of the service. This is in contrast to REST APIs which expose a suite of URLs each of which expose a single resource. While GraphQL could be used alongside a suite of resource URLs, this can make it harder to use with tools like [GraphiQL](https://github.com/graphql/graphiql). |
16 | | - |
17 | | -Read more about this in [Serving over HTTP](/learn/serving-over-http/). |
18 | | - |
19 | | -## JSON (with GZIP) |
20 | | - |
21 | | -GraphQL services typically respond using JSON, however the GraphQL spec [does not require it](http://spec.graphql.org/draft/#sec-Serialization-Format). JSON may seem like an odd choice for an API layer promising better network performance, however because it is mostly text, it compresses exceptionally well with GZIP. |
22 | | - |
23 | | -It's encouraged that any production GraphQL services enable GZIP and encourage their clients to send the header: |
24 | | - |
25 | | -``` |
26 | | -Accept-Encoding: gzip |
27 | | -``` |
28 | | - |
29 | | -JSON is also very familiar to client and API developers, and is easy to read and debug. In fact, the GraphQL syntax is partly inspired by the JSON syntax. |
30 | | - |
31 | | -## Versioning |
32 | | - |
33 | | -While there's nothing that prevents a GraphQL service from being versioned just like any other REST API, GraphQL takes a strong opinion on avoiding versioning by providing the tools for the continuous evolution of a GraphQL schema. |
34 | | - |
35 | | -Why do most APIs version? When there's limited control over the data that's returned from an API endpoint, _any change_ can be considered a breaking change, and breaking changes require a new version. If adding new features to an API requires a new version, then a tradeoff emerges between releasing often and having many incremental versions versus the understandability and maintainability of the API. |
36 | | - |
37 | | -In contrast, GraphQL only returns the data that's explicitly requested, so new capabilities can be added via new types and new fields on those types without creating a breaking change. This has led to a common practice of always avoiding breaking changes and serving a versionless API. |
38 | | - |
39 | | -## Nullability |
40 | | - |
41 | | -Most type systems which recognise "null" provide both the common type and the _nullable_ version of that type, whereby default types do not include "null" unless explicitly declared. However, in a GraphQL type system, every field is _nullable_ by default. This is because there are many things that can go awry in a networked service backed by databases and other services. A database could go down, an asynchronous action could fail, an exception could be thrown. Beyond simply system failures, authorization can often be granular, where individual fields within a request can have different authorization rules. |
42 | | - |
43 | | -By defaulting every field to _nullable_, any of these reasons may result in just that field returned "null" rather than having a complete failure for the request. Instead, GraphQL provides [non-null](/learn/schema/#lists-and-non-null) variants of types which make a guarantee to clients that if requested, the field will never return "null". Instead, if an error occurs, the previous parent field will be "null" instead. |
44 | | - |
45 | | -When designing a GraphQL schema, it's important to keep in mind all the problems that could go wrong and if "null" is an appropriate value for a failed field. Typically it is, but occasionally, it's not. In those cases, use non-null types to make that guarantee. |
46 | | - |
47 | | -## Pagination |
48 | | - |
49 | | -The GraphQL type system allows for some fields to return [lists of values](/learn/schema/#lists-and-non-null), but leaves the pagination of longer lists of values up to the API designer. There are a wide range of possible API designs for pagination, each of which has pros and cons. |
50 | | - |
51 | | -Typically, fields that could return long lists accept arguments "first" and "after" to allow for specifying a specific region of a list, where "after" is a unique identifier of each of the values in the list. |
52 | | - |
53 | | -Ultimately designing APIs with feature-rich pagination led to a best practice pattern called "Connections". Some client tools for GraphQL, such as [Relay](https://facebook.github.io/relay/), know about the Connections pattern and can automatically provide support for client-side pagination when a GraphQL API employs this pattern. |
54 | | - |
55 | | -Read more about this in the article on [Pagination](/learn/pagination/). |
56 | | - |
57 | | -## Server-side Batching & Caching |
58 | | - |
59 | | -GraphQL is designed in a way that allows you to write clean code on the server, where every field on every type has a focused single-purpose function for resolving that value. However without additional consideration, a naive GraphQL service could be very "chatty" or repeatedly load data from your databases. |
60 | | - |
61 | | -This is commonly solved by a batching technique, where multiple requests for data from a backend are collected over a short period of time and then dispatched in a single request to an underlying database or microservice by using a tool like Facebook's [DataLoader](https://github.com/facebook/dataloader). |
| 9 | +<Cards |
| 10 | + items={[ |
| 11 | + { |
| 12 | + title: "Thinking in Graphs", |
| 13 | + link: "/learn/thinking-in-graphs/", |
| 14 | + description: "Model your business domain as a graph", |
| 15 | + }, |
| 16 | + { |
| 17 | + title: "Serving over HTTP", |
| 18 | + link: "/learn/serving-over-http/", |
| 19 | + description: "Handle GraphQL requests on HTTP servers", |
| 20 | + }, |
| 21 | + { |
| 22 | + title: "Authorization", |
| 23 | + link: "/learn/authorization/", |
| 24 | + description: "Delegate authorization logic to the business logic layer", |
| 25 | + }, |
| 26 | + { |
| 27 | + title: "Pagination", |
| 28 | + link: "/learn/pagination/", |
| 29 | + description: "Allow clients to traverse lists of objects with a consistent field pagination model", |
| 30 | + }, |
| 31 | + { |
| 32 | + title: "Schema Design", |
| 33 | + link: "/learn/schema-design/", |
| 34 | + description: "Design and evolve a type system over time without versions", |
| 35 | + }, |
| 36 | + { |
| 37 | + title: "Global Object Identification", |
| 38 | + link: "/learn/global-object-identification/", |
| 39 | + description: "Consistent object access enables simple caching and object lookups", |
| 40 | + }, |
| 41 | + { |
| 42 | + title: "Caching", |
| 43 | + link: "/learn/caching/", |
| 44 | + description: "Provide Object Identifiers so clients can build rich caches", |
| 45 | + }, |
| 46 | + { |
| 47 | + title: "Performance", |
| 48 | + link: "/learn/performance/", |
| 49 | + description: "Optimize the execution and delivery of GraphQL responses", |
| 50 | + }, |
| 51 | + { |
| 52 | + title: "Security", |
| 53 | + link: "/learn/security/", |
| 54 | + description: "Protect GraphQL APIs from malicious operations", |
| 55 | + }, |
| 56 | + ]} |
| 57 | +/> |
0 commit comments