Ga naar inhoud
Restorm Restorm-documentatie

Een GraphQL-schema importeren

Restorm importeert een GraphQL-schema in SDL — het tekstformaat, dat van de bestanden .graphql en .gql.

Importeren

Section titled “Importeren”

Bestand ▸ Importeren (Ctrl+I) en daarna het schemabestand. Geplakte inhoud werkt ook: Restorm herkent een SDL aan de aanwezigheid van type Query, type Mutation of schema {.

De boom die de import van een GraphQL-schema oplevert: een omgevingsmap “GraphQL API”, een map Queries en een map Mutations, met één GQL-verzoek per rootveld

Wat er wordt geïmporteerd

Section titled “Wat er wordt geïmporteerd”
ElementWat Restorm daarmee doet
RoottypenEén map per operatietype (Query, Mutation, Subscription)
Elk rootveldEen GraphQL-verzoek met het bijbehorende operationType
ArgumentenOperatievariabelen, vooraf gevuld met plaatsvervangende waarden
Beschrijvingen en typenDe API-documentatie
enumEnumeraties die als waardetype herbruikbaar zijn

Bijwerken

Section titled “Bijwerken”

GraphQL hoort bij de formaten die opnieuw te synchroniseren zijn (als het schema vanaf een URL is geïmporteerd): de knop Vernieuwen van de map haalt de bron op en Restorm past het verschil toe. Zie Bijwerken vanaf de bron.