如何用API Platform构建GraphQL API？功能确认与实现方法问询

Absolutely! API Platform fully supports building GraphQL APIs — as its tagline states, it’s designed for both REST and GraphQL-driven projects. The docs can be easy to overlook at first glance, so let’s break down exactly how to set this up step by step.

1. Adding GraphQL Support to Your Project #

For a New API Platform Project #

When starting fresh, you can enable GraphQL right from the creation process. Use the Symfony CLI (recommended) or Composer to spin up a project with GraphQL pre-configured:

symfony new my-graphql-api --webapp
cd my-graphql-api
composer require api-platform/graphql

Alternatively, if you use the official API Platform starter project:

composer create-project api-platform/api-platform my-graphql-api
# During the setup prompts, select "Yes" when asked about enabling GraphQL

For an Existing API Platform Project #

If you already have a REST API built with API Platform, adding GraphQL is just a single command away:

composer require api-platform/graphql

This will automatically configure the GraphQL endpoint, install required dependencies, and update your project’s config files — no manual setup needed.

2. Exposing Entities via GraphQL #

Any entity you’ve marked with the #[ApiResource] attribute will automatically get GraphQL CRUD operations (queries and mutations) generated for it. For example:

// src/Entity/Book.php
namespace App\Entity;

use ApiPlatform\Metadata\ApiResource;
use Doctrine\ORM\Mapping as ORM;

#[ApiResource]
#[ORM\Entity]
class Book
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    private ?int $id = null;

    #[ORM\Column(type: 'string', length: 255)]
    private ?string $title = null;

    // Add getters and setters here...
}

This simple entity will now have GraphQL operations like book (fetch single item), books (fetch list), createBook, updateBook, and deleteBook ready to use.

3. Testing the GraphQL API #

Once setup is done, your GraphQL endpoint lives at /graphql. You can use the built-in GraphiQL playground (a web-based IDE) at /graphql/playground to write and test queries/mutations directly in your browser.

Start your Symfony server first:

symfony server:start

Then head to http://localhost:8000/graphql/playground and run a test query like this:

query GetAllBooks {
  books {
    id
    title
  }
}

You’ll get back a list of your Book entities (or an empty array if you haven’t added any yet).

4. Customizing Your GraphQL API #

If you need to tweak operations (like disabling certain mutations, adding custom queries, or hiding fields), you can do it via the #[ApiResource] attribute. For example, to disable the delete mutation for your Book entity:

#[ApiResource(
    graphQlOperations: [
        new Query(name: 'books'),
        new Query(name: 'book'),
        new Mutation(name: 'createBook'),
        new Mutation(name: 'updateBook'),
        // Omit the delete mutation to disable it
    ]
)]

You can also build custom resolvers for complex logic by implementing the ResolverInterface and linking it to your GraphQL operations.

内容的提问来源于stack exchange，提问作者Putxe