Skip to content

Commit 00e8598

Browse files
docs: clarify default GraphQL endpoint for Symfony and Laravel variants (#2168)
1 parent 8aa8def commit 00e8598

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

core/graphql.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ To enable GraphQL and its IDE (GraphiQL and GraphQL Playground) in your API, sim
1616
composer require api-platform/graphql
1717
```
1818

19-
You can now use GraphQL at the endpoint: `https://localhost:8443/graphql`.
19+
You can now use GraphQL at the endpoint: `https://localhost/graphql`.
2020

2121
> [!NOTE]
2222
> If you used [the Symfony Variant thanks to Symfony Flex](../symfony/index.md#installing-the-framework) or the Laravel
23-
> variant, URLs will be prefixed with `/api` by default. For example, the GraphQL endpoint will be: `https://localhost:8443/api/graphql`.
23+
> variant, the default GraphQL endpoint will be available at a relative URL like `/graphql`. For example: `https://localhost/graphql`.
2424
2525
## Changing Location of the GraphQL Endpoint
2626

@@ -33,12 +33,12 @@ Using the Symfony variant we can do this modification by adding the following co
3333
```yaml
3434
# api/config/routes.yaml
3535
api_graphql_entrypoint:
36-
path: /api/graphql
36+
path: /graphql
3737
controller: api_platform.graphql.action.entrypoint
3838
# ...
3939
```
4040

41-
Change `/api/graphql` to the URI you wish the GraphQL endpoint to be accessible on.
41+
Change `/graphql` to the URI you wish the GraphQL endpoint to be accessible on.
4242

4343
### Laravel Routes
4444

@@ -49,11 +49,11 @@ Using the Laravel variant we can do this modification by adding the following co
4949
use Illuminate\Support\Facades\Route;
5050
use ApiPlatform\GraphQL\Action\EntrypointAction;
5151

52-
Route::post('/api/graphql', EntrypointAction::class)
52+
Route::post('/graphql', EntrypointAction::class)
5353
->name('api_graphql_entrypoint');
5454
```
5555

56-
Change `/api/graphql` to the URI you wish the GraphQL endpoint to be accessible on.
56+
Change `/graphql` to the URI you wish the GraphQL endpoint to be accessible on.
5757

5858
## GraphiQL
5959

0 commit comments

Comments
 (0)