Créer une API
Créer une APICréer une configuration du schéma

Créer une configuration du schéma

Une configuration du schéma est utilisée pour personnaliser le schéma pour les Endpoints Personnalisés et les Requêtes Persistées.

Le schéma GraphQL peut être configuré avec les éléments fournis par les différents modules installés et activés. (Rendez-vous sur la page des Modules pour voir la liste de tous les modules.)

Chaque module peut définir sa configuration via son propre bloc dans l'éditeur de Configuration du Schéma. Cela inclut des blocs pour :

Configuration du Schéma

Accéder à toutes les configurations du schéma

En cliquant sur "Schema Configurations" dans le menu du plugin, la liste de toutes les configurations s'affiche :

Configurations du Schéma dans l'admin
Configurations du Schéma dans l'admin

Créer une nouvelle configuration du schéma

Cliquez sur le bouton "Add New Schema Configuration" pour ouvrir l'éditeur WordPress :

Créer une nouvelle Configuration du Schéma
Créer une nouvelle Configuration du Schéma

Supprimer des blocs utilisant des configurations de valeur "Default" (optionnel)

Nous pouvons supprimer les blocs de configuration qui utilisent la valeur "Default" correspondante des Paramètres.

Le bloc supprimé peut être rajouté via le menu d'insertion, en cliquant sur le bouton + en bas (notez qu'une seule instance de chaque bloc peut être insérée) :

Supprimer et ajouter des blocs dans la Configuration du Schéma

Ensuite, fournissez la configuration pour les blocs requis.

Décrire la configuration du schéma

Utilisez le champ "Extrait", dans le panneau des paramètres du document, pour donner une description à la configuration du schéma.

Consultez plus d'informations dans le guide Ajouter une description à l'API.

Publier la configuration du schéma

Sélectionnez les éléments requis pour la configuration du schéma et ajustez les options. Lorsque c'est prêt, cliquez sur "Publier" :

Créer une nouvelle configuration du schéma

Utiliser la configuration du schéma

Une fois publiée, la configuration du schéma devient disponible pour les éditeurs des Endpoints Personnalisés et des Requêtes Persistées :

Sélectionner la Configuration du Schéma dans l'Endpoint Personnalisé

Voir la configuration du schéma

Ouvrir le permalink de la configuration du schéma dans le navigateur affichera son contenu (à condition que l'utilisateur soit connecté et que son rôle y ait accès) :

Source de la configuration du schéma