Skip to content

Commit a7b8058

Browse files
Merge branch 'Urigo-patch-1'
2 parents 09216f5 + 7c693b6 commit a7b8058

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

content/graphql/quick-start.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[GraphQL](https://graphql.org/) is a powerful query language for APIs and a runtime for fulfilling those queries with your existing data. It's an elegant approach that solves many problems typically found with REST APIs. For background, we suggest reading this [comparison](https://dev-blog.apollodata.com/graphql-vs-rest-5d425123e34b) between GraphQL and REST. GraphQL combined with [TypeScript](https://www.typescriptlang.org/) helps you develop better type safety with your GraphQL queries, giving you end-to-end typing.
44

5-
In this chapter, we assume a basic understanding of GraphQL, and focus on how to work with the built-in `@nestjs/graphql` module. The `GraphQLModule` can be configured to use [Apollo](https://www.apollographql.com/) server (with the `@nestjs/apollo` driver) and [Mercurius](https://github.com/mercurius-js/mercurius) (with the `@nestjs/mercurius`). We provide official integrations for these proven GraphQL packages to provide a simple way to use GraphQL with Nest. You can also build your own dedicated driver (read more on that [here](/graphql/other-features#creating-a-custom-driver)).
5+
In this chapter, we assume a basic understanding of GraphQL, and focus on how to work with the built-in `@nestjs/graphql` module. The `GraphQLModule` can be configured to use [Apollo](https://www.apollographql.com/) server (with the `@nestjs/apollo` driver) and [Mercurius](https://github.com/mercurius-js/mercurius) (with the `@nestjs/mercurius`). We provide official integrations for these proven GraphQL packages to provide a simple way to use GraphQL with Nest (see more integrations [here]()).
6+
7+
You can also build your own dedicated driver (read more on that [here](/graphql/other-features#creating-a-custom-driver)).
68

79
#### Installation
810

@@ -16,7 +18,7 @@ $ npm i @nestjs/graphql @nestjs/apollo graphql apollo-server-express
1618
# npm i @nestjs/graphql @nestjs/apollo graphql apollo-server-fastify
1719

1820
# For Fastify and Mercurius
19-
# npm i @nestjs/graphql @nestjs/mercurius graphql mercurius
21+
# npm i @nestjs/graphql @nestjs/mercurius graphql mercurius
2022
```
2123

2224
> warning **Warning** `@nestjs/graphql@>=9` and `@nestjs/apollo^10` packages are compatible with **Apollo v3** (check out Apollo Server 3 [migration guide](https://www.apollographql.com/docs/apollo-server/migration/) for more details), while `@nestjs/graphql@^8` only supports **Apollo v2** (e.g., `[email protected]` package).
@@ -346,6 +348,10 @@ export class AppModule {}
346348
347349
The `forRoot()` method takes an options object as an argument. These options are passed through to the underlying driver instance. Read more about available settings [here](https://github.com/mercurius-js/mercurius/blob/master/docs/api/options.md#plugin-options).
348350

351+
#### Third-party integrations
352+
353+
- [GraphQL Yoga](https://github.com/charlypoly/graphql-yoga-nestjs)
354+
349355
#### Example
350356

351357
A working example is available [here](https://github.com/nestjs/nest/tree/master/sample/33-graphql-mercurius).

0 commit comments

Comments
 (0)