File tree Expand file tree Collapse file tree
packages/web/docs/src/content/router/configuration Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -32,12 +32,26 @@ The `port` property specifies the network port that the router will listen on. E
3232not already in use by another service on the same host. When running in a container, this is the
3333port you will need to expose.
3434
35+ ### ` graphql_endpoint `
36+
37+ - ** Type:** ` string `
38+ - ** Default:** ` /graphql `
39+
40+ The ` graphql_endpoint ` property specifies the URL path at which the router will expose its GraphQL
41+ API.
42+
43+ You may also use ` /graphql/{wildcard} ` if you wish to capture nested paths within the same request,
44+ or ` /graphql/{tail}* ` to capture any remaining path segments.
45+
3546## Example
3647
37- This example configures the router to listen only on the localhost interface on port ` 8080 ` .
48+ This example configures the router to listen only on the localhost interface on port ` 8080 ` and on
49+ path ` /my_graphql_router ` , so it will accept GraphQL requests on
50+ ` http://127.0.0.1:8080/my_graphql_router ` .
3851
3952``` yaml filename="router.config.yaml"
4053http :
4154 host : ' 127.0.0.1'
4255 port : 8080
56+ graphql_endpoint : /my_graphql_router
4357` ` `
You can’t perform that action at this time.
0 commit comments