How to disable REST completely?

[danaki]

In my project I use GraphQL only and need no to configure REST operations. How do I disable REST and leave GraphQL support only?

[teohhanhui]

That makes me sad. 😢

But on a more serious note, it's not currently possible, because GraphQL uses the generic application/json MIME type.

[dunglas]

You can register only the GraphQL route, instead of all API Platform routes. Replace the content of config/routes/api_platform.yml by:

api_platform_graphql:
    resource: '@ApiPlatformBundle/Resources/config/routing/graphql.xml'

It should do the trick.

[dunglas]

Ideally, we should add a flag to disable REST, and not register the kernel listeners in this case. In the meantime the previous solution should be good enough.

[lukasluecke]

@dunglas Your suggestion with the routing modifications sadly doesn't work.

The main issue is that GraphQL still uses the routes for IRI generation, not sure if that can easily be solved by still registering the routes, but not attaching the listeners?

[teohhanhui]

@lukasluecke You could try manually overriding some of the built-in event listeners with the same service IDs. But we need to identify which listeners are used by GraphQL, and which are not.

[teohhanhui]

Hmm... Actually I think an easier way would be to just do:

<?php
// api/src/Entity/Book.php

use ApiPlatform\Core\Annotation\ApiResource;

/**
 * @ApiResource(
 *     graphql={
 *         ...
 *     },
 *     collectionOperations={
 *     },
 *     itemOperations={
 *     },
 * )
 */
class Book
{

EDIT: Sorry, this wouldn't really work, as certain operations are still compulsory for IRI generation, as @lukasluecke has pointed out.

[lukasluecke]

Related to #2954 (since this should be the only thing that's currently still required from the REST operations, if you want GraphQL to work)

[lukasluecke]

@dunglas Was this not already resolved? (#3079 and api-platform/docs#886)
Maybe we should close #2954 to prevent confusion.

[dunglas]

Good catch! To entirely fix this one we should add a config option to easily disable everything that can be disabled from the REST subsystem.

[lukasluecke]

@dunglas I'll try to get something in for #2946 soonish, which should also make it possible to globally define these operation settings (and then have a doc entry with the exact settings to use) - do you think that would be enough?

[dunglas]

Could also be related to #3099 right?