PHP Academy · Lezione

Creare uno schema con graphql-php

Definisca tipi e uno schema con webonyx/graphql-php

Creare uno schema con graphql-php è una lezione PHP Academy gratuita su CoddyKit. Questa è la lezione 2 di 4. Puoi leggere la lezione completa qui gratuitamente — poi esercitati direttamente nel browser con un editor di codice integrato e un tutor IA disponibile 24/7. Fa parte del percorso di apprendimento PHP Academy, e i tuoi progressi si sincronizzano tra il web e l'app CoddyKit. Il corso PHP Academy include 4 lezioni in totale.

graphql-php: l'implementazione di riferimento

webonyx/graphql-php è il porting PHP de facto dell'implementazione di riferimento di GraphQL. Fornisce il sistema di tipi, il parser, il validatore e l'esecutore. Può definire lo schema in modo programmatico (oggetti PHP) oppure a partire da SDL (schema-first). In questa lezione costruiremo uno schema manualmente, così comprenderà esattamente il ruolo di ogni elemento.

composer require webonyx/graphql-php

Scalari e registro dei tipi

Ogni valore GraphQL termina in uno scalare: Int, Float, String, Boolean, ID. In graphql-php questi tipi sono disponibili tramite la facciata Type. Poiché i tipi oggetto si referenziano a vicenda (e referenziano se stessi), un pattern comune è un TypeRegistry statico che memorizza ogni tipo, così da costruirlo una sola volta.

<?php
use GraphQL\Type\Definition\Type;

// Built-in scalars, returned as singletons:
var_dump(Type::int()->name);     // "Int"
var_dump(Type::string()->name);  // "String"
var_dump(Type::id()->name);      // "ID"
var_dump(Type::nonNull(Type::string())->toString()); // "String!"

Definire un ObjectType

Un ObjectType ha un name e una mappa fields. Ogni campo dichiara il proprio type e, facoltativamente, un callback resolve. Se si omette resolve, graphql-php usa il resolver predefinito, che legge la chiave dell'array corrispondente oppure la proprietà o il getter dal valore padre.

<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;

$postType = new ObjectType([
    'name' => 'Post',
    'fields' => [
        'id'    => Type::nonNull(Type::id()),
        'title' => Type::nonNull(Type::string()),
        'body'  => Type::string(),
    ],
]);

Wrapping non-null e liste

I tipi wrapper esprimono la nullabilità e la cardinalità:

Type::nonNull(T) → T! (mai nullo).
Type::listOf(T) → [T] (un elenco che può essere nullo e può contenere elementi nulli).
[Post!]! = un elenco non nullo di post non nulli → nonNull(listOf(nonNull($postType))).

Presti attenzione: questo è il contratto di nullabilità dello schema con i client.

<?php
use GraphQL\Type\Definition\Type;

// [Post!]!  -- a required list whose elements are never null
$wrapped = Type::nonNull(Type::listOf(Type::nonNull(Type::string())));
echo $wrapped->toString(), "\n"; // [String!]!

I campi lazy interrompono i riferimenti circolari

Un User ha posts e un Post ha un author (un User). Per costruire tipi che si referenziano a vicenda, passi fields come closure anziché come array. La closure viene eseguita in modo lazy, dopo che entrambi i tipi esistono, evitando il problema dell'uovo e della gallina.

<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;

class Types {
    private static array $cache = [];

    public static function user(): ObjectType {
        return self::$cache['User'] ??= new ObjectType([
            'name' => 'User',
            'fields' => fn() => [           // lazy!
                'id'    => Type::nonNull(Type::id()),
                'name'  => Type::nonNull(Type::string()),
                'posts' => Type::listOf(self::post()),
            ],
        ]);
    }

    public static function post(): ObjectType {
        return self::$cache['Post'] ??= new ObjectType([
            'name' => 'Post',
            'fields' => fn() => [
                'id'     => Type::nonNull(Type::id()),
                'title'  => Type::nonNull(Type::string()),
                'author' => self::user(),    // back-reference
            ],
        ]);
    }
}

Argomenti dei campi

I campi possono accettare argomenti. Li dichiari nella chiave args; vengono passati come secondo parametro ($args) del resolver. Gli argomenti sono tipizzati a loro volta, possono essere non null e possono avere un defaultValue.

<?php
use GraphQL\Type\Definition\Type;

$userField = [
    'type' => Type::string(),
    'args' => [
        'id'     => Type::nonNull(Type::id()),
        'locale' => ['type' => Type::string(), 'defaultValue' => 'en'],
    ],
    'resolve' => fn($root, array $args) => "user {$args['id']} ({$args['locale']})",
];

Il tipo Query radice

Ogni schema necessita di un tipo radice Query — i punti di ingresso da cui i client possono iniziare. Qui esponiamo un singolo campo hello per poter eseguire una richiesta dall'inizio alla fine. Il primo argomento del resolver radice è il rootValue dello schema (spesso null).

<?php
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;

$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'hello' => [
            'type' => Type::string(),
            'args' => ['name' => Type::nonNull(Type::string())],
            'resolve' => fn($root, array $args) => 'Hello, ' . $args['name'],
        ],
    ],
]);

Comporre ed eseguire lo schema

Racchiuda il tipo query in uno Schema ed esegua una stringa di query tramite GraphQL::executeQuery(). L'oggetto risultato viene convertito nell'array canonico { data, errors } tramite toArray().

<?php
require 'vendor/autoload.php';

use GraphQL\GraphQL;
use GraphQL\Type\Schema;
use GraphQL\Type\Definition\ObjectType;
use GraphQL\Type\Definition\Type;

$queryType = new ObjectType([
    'name' => 'Query',
    'fields' => [
        'hello' => [
            'type' => Type::string(),
            'args' => ['name' => Type::nonNull(Type::string())],
            'resolve' => fn($root, $args) => 'Hello, ' . $args['name'],
        ],
    ],
]);

$schema = new Schema(['query' => $queryType]);
$result = GraphQL::executeQuery($schema, '{ hello(name: "Ada") }');
echo json_encode($result->toArray());
// {"data":{"hello":"Hello, Ada"}}

Alternativa schema-first con BuildSchema

Se preferisce SDL, BuildSchema::build() analizza una stringa di schema e la trasforma in uno schema eseguibile. Quindi colleghi i resolver separatamente (ad esempio con un callback di risoluzione del campo), mantenendo dichiarative le definizioni dei tipi, mentre la logica resta in PHP.

<?php
use GraphQL\Utils\BuildSchema;

$sdl = <<<'GQL'
type Query {
  hello(name: String!): String
}
GQL;

$schema = BuildSchema::build($sdl);
// Provide resolvers via the executeQuery $fieldResolver argument
// or with a type config decorator.

Validare prima del rilascio

graphql-php valida automaticamente le query in ingresso rispetto allo schema prima dell'esecuzione. Può anche verificare che lo schema sia internamente coerente in fase di build/CI con $schema->assertValid(): così individua refusi e riferimenti non validi prima del deploy, non al momento della richiesta.

<?php
use GraphQL\Type\Schema;

/** @var Schema $schema */
$schema->assertValid(); // throws InvariantViolation on a broken schema
echo "schema OK\n";

Enum e scalari personalizzati

Al di là degli oggetti, due tipi completano la maggior parte degli schemi. EnumType vincola un campo a un insieme fisso di valori nominati. CustomScalarType permette di definire scalari di dominio (DateTime, Email) con la propria logica serialize/parseValue/parseLiteral, in modo che i valori vengano validati e normalizzati al confine del sistema.

<?php
use GraphQL\Type\Definition\EnumType;

$statusEnum = new EnumType([
    'name' => 'PostStatus',
    'values' => [
        'DRAFT'     => ['value' => 0],
        'PUBLISHED' => ['value' => 1],
        'ARCHIVED'  => ['value' => 2],
    ],
]);
// A field typed as $statusEnum only accepts DRAFT/PUBLISHED/ARCHIVED.

Verifica rapida

Perché passare fields come closure?

Riepilogo

Ha costruito uno schema partendo da zero:

Gli scalari e i tipi wrapper (nonNull, listOf) esprimono il contratto di nullabilità/cardinalità.
ObjectType con una mappa di campi (o una closure lazy) definisce le forme dei dati.
Un registro dei tipi con memoization gestisce i riferimenti circolari.
I campi accettano args tipizzati; il tipo Query radice è il punto di ingresso.
GraphQL::executeQuery() esegue lo schema; assertValid() ne protegge la validità in CI.

Prossimo: resolver, mutation e subscription.

Domande Frequenti

La lezione «Creare uno schema con graphql-php» è gratuita?

Sì — il testo completo di «Creare uno schema con graphql-php» è gratuito qui sul web. Per esercitarvi in modo interattivo (un editor di codice integrato e un tutor IA 24/7) e sbloccare il resto del corso PHP Academy, passa a CoddyKit PRO. Il corso PHP Academy include 4 lezioni in totale.

Cosa imparerò in «Creare uno schema con graphql-php»?

Definisca tipi e uno schema con webonyx/graphql-php Eserciti PHP Academy con codice pratico che esegui direttamente nel browser, e un tutor IA 24/7 risponde alle tue domande mentre lavori sulla lezione.

Ho bisogno di esperienza per iniziare PHP Academy?

Non è richiesta alcuna esperienza precedente. PHP Academy su CoddyKit è strutturato per principianti e studenti avanzati, quindi puoi iniziare da qui o dall'inizio e procedere al tuo ritmo. Questa è la lezione 2 di 4.

Quanto tempo richiede la lezione «Creare uno schema con graphql-php»?

La maggior parte delle lezioni CoddyKit richiede circa 5–10 minuti. Ogni lezione è breve e interattiva, quindi fai progressi costanti e riprendi esattamente da dove hai lasciato su web e app.

Posso scrivere ed eseguire codice in questa lezione PHP Academy?

Sì. Ogni lezione PHP Academy include un editor di codice integrato, quindi scrivi ed esegui codice reale direttamente nel tuo browser e ricevi feedback istantaneo dall'IA — nessuna configurazione locale necessaria.

Tutte le lezioni di questo corso

← Torna a PHP Academy