Del via

Fabric API for GraphQL introspection and schema export

Fabric API for GraphQL inneholder to mekanismer for å hente informasjon om skjemaet.

  1. Introspeksjon: Det er en del av GraphQL-standarden og aktiverer programmatisk spørring av skjemaet. Med introspeksjonsspørringer kan du lære om et GraphQL API-skjema, og de hjelper også power GraphQL-utviklingsverktøy.

  2. Skjemaeksport: Den lar deg hente en SDL-fil (GraphQL Schema Definition Language) som inneholder det fullstendige skjemaet for ekstern bruk.

Introspeksjon

Som standard deaktiveres introspeksjon på API-en for GraphQL-elementer. Denne innstillingen kan bare veksles av administratorer for arbeidsområder. Alle andre brukere ser en deaktivert glidebryter. Hvis du vil aktivere den, klikker du på API-innstillinger-tannhjulikonet i den øverste menyen og velger Introspection fra de tilgjengelige innstillingene. Du ser en veksleknapp for å aktivere eller deaktivere introspeksjon:

Skjermbilde som viser portallinjen som viser innstillings tannhjulknappen.

Skjermbilde som viser glidebryteren for innstilling for introspeksjon.

Hvis du aktiverer introspeksjon, vises følgende bekreftelsesdialogboks:

Skjermbilde som viser bekreftelsesdialogboksen aktiver introspeksjon.

Velg bekreft for å aktivere introspeksjon, eller avbryt for å la den være deaktivert.

Eksempel på introspeksjonsspørring

Her er et raskt eksempel på en introspeksjonsspørring for å hente tilgjengelige typer fra skjemaet:

query {
    __schema {
        types{
            name
        }
    }
}

Skjermbilde som viser eksempelet på introspeksjonsspørringen.

Informasjonen som hentes av introspeksjonsspørringer, er detaljert. Du kan bruke spørringsfiltre til å begrense omfanget av spørringen.

Hvis du vil ha mer informasjon om introspeksjon, kan du se GraphQL Foundations offisielle dokumentasjon om introspeksjon.

Eksporter skjema

En annen måte å hente skjemainformasjon på, er å bruke GraphQL-skjemaeksporten. Det fungerer direkte fra Fabric-portalen. Åpne API-en for GraphQL, og velg Eksporter skjema. Nettleseren laster ned en SDL-fil (Skjemadefinisjonsspråk) med fullstendig skjema. Deretter kan du bruke denne SDL-filen i alle utviklingsverktøy eller -tjenester, for eksempel integrere med Azure API Management.

Skjermbilde som viser eksportskjemaknappen.

Relatert innhold