You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/graphql/quick-start.md
+24-13
Original file line number
Diff line number
Diff line change
@@ -88,19 +88,18 @@ With that in place, and with your application running in the background, you can
88
88
<imgsrc="/assets/playground.png"alt="" />
89
89
</figure>
90
90
91
-
> warning **Note**`@nestjs/mercurius` integration does not ship with the built-in GraphQL Playground integration. Instead, you can use [GraphiQL](https://github.com/graphql/graphiql) (set `graphiql: true`).
92
-
93
-
#### Multiple endpoints
94
-
95
-
Another useful feature of the `@nestjs/graphql` module is the ability to serve multiple endpoints at once. This lets you decide which modules should be included in which endpoint. By default, `GraphQL` searches for resolvers throughout the whole app. To limit this scan to only a subset of modules, use the `include` property.
96
-
97
-
```typescript
98
-
GraphQLModule.forRoot({
99
-
include: [CatsModule],
100
-
}),
101
-
```
102
-
103
-
> warning **Warning** If you use the `@apollo/server` with `@as-integrations/fastify` package with multiple GraphQL endpoints in a single application, make sure to enable the `disableHealthCheck` setting in the `GraphQLModule` configuration.
91
+
> info **Note**`@nestjs/mercurius` integration does not ship with the built-in GraphQL Playground integration. Instead, you can use [GraphiQL](https://github.com/graphql/graphiql) (set `graphiql: true`).
92
+
93
+
> warning **Warning** Update (04/14/2025): The default Apollo playground has been deprecated and will be removed in the next major release. Instead, you can use [GraphiQL](https://github.com/graphql/graphiql), just set `graphiql: true` in the `GraphQLModule` configuration, as shown below:
94
+
>
95
+
> ```typescript
96
+
>GraphQLModule.forRoot<ApolloDriverConfig>({
97
+
> driver: ApolloDriver,
98
+
> graphiql: true,
99
+
> }),
100
+
>```
101
+
>
102
+
> If your application uses [subscriptions](/graphql/subscriptions), be sure to use `graphql-ws`, as `subscriptions-transport-ws` isn't supported by GraphiQL.
104
103
105
104
#### Code first
106
105
@@ -356,6 +355,18 @@ export class AppModule {}
356
355
357
356
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).
358
357
358
+
#### Multiple endpoints
359
+
360
+
Another useful feature of the `@nestjs/graphql` module is the ability to serve multiple endpoints at once. This lets you decide which modules should be included in which endpoint. By default, `GraphQL` searches for resolvers throughout the whole app. To limit this scan to only a subset of modules, use the `include` property.
361
+
362
+
```typescript
363
+
GraphQLModule.forRoot({
364
+
include: [CatsModule],
365
+
}),
366
+
```
367
+
368
+
> warning **Warning** If you use the `@apollo/server` with `@as-integrations/fastify` package with multiple GraphQL endpoints in a single application, make sure to enable the `disableHealthCheck` setting in the `GraphQLModule` configuration.
0 commit comments