Skip to main content

​
Ajouter un schéma GraphQL

Pour créer des pages pour votre API GraphQL, vous avez besoin d’un schéma GraphQL valide au format SDL (Schema Definition Language). Stockez le schéma dans votre dépôt de documentation ou hébergez-le à une URL HTTPS que Mintlify peut récupérer.
schema.graphql

​
Remplir automatiquement les pages GraphQL

Pour générer automatiquement des pages pour chaque requête, mutation et type de votre schéma, ajoutez une propriété graphql à un onglet dans votre docs.json. Mintlify analyse le schéma et crée une page pour chaque opération et chaque type nommé.
La propriété graphql accepte soit une chaîne (un chemin local ou une URL HTTPS), soit un objet avec les champs suivants :
​
string
requis
Un chemin local vers un fichier SDL dans votre dépôt de documentation ou une URL HTTPS vers un fichier SDL hébergé. Les URL HTTP ne sont pas acceptées.
​
string
Le répertoire dans lequel les pages générées sont placées. Par défaut, graphql-reference.
Les sources GraphQL ne sont prises en charge que sur les onglets. Un onglet qui déclare graphql ne peut pas également déclarer openapi ou asyncapi.

​
Pages générées

Mintlify organise les pages générées en trois sections sous l’onglet que vous avez configuré :
  • Queries — une page par champ de votre type racine Query.
  • Mutations — une page par champ de votre type racine Mutation.
  • Types — une page par type nommé (object, input, enum, interface, union ou scalar).
Chaque page d’opération affiche la description du champ, les arguments, le type de retour et des liens vers tous les types référencés. Les pages de requêtes et de mutations comprennent également un exemple d’opération généré, les variables requises et un exemple de réponse JSON dans le panneau latéral (ou en ligne sur mobile). Les pages de types affichent la définition du schéma en lecture seule, avec des types de champs liés afin que les lecteurs puissent naviguer dans le graphe.

​
Dépréciations

Les champs et les arguments marqués avec @deprecated dans votre schéma sont signalés comme dépréciés sur les pages générées. La raison de la dépréciation, lorsqu’elle est fournie, apparaît à côté du champ.

​
Mettre à jour votre documentation

Mintlify régénère les pages de référence GraphQL lorsque vous exécutez mint dev ou lorsque vous poussez des modifications vers votre dépôt de documentation. Si votre schéma est hébergé à une URL HTTPS, les mises à jour du schéma sont prises en compte lors de la prochaine build.