Del via

Struktur-API for GraphQL-skjemavisning og skjemautforsker

Fabric API for GraphQL genererer automatisk et skjema som definerer strukturen til API-et ditt basert på datakildene du kobler til. Skjemaet, skrevet i GraphQL Schema Definition Language (SDL), beskriver alle tilgjengelige typer, felt, spørringer og mutasjoner som klienter kan bruke for å samhandle med dataene dine.

Skjemavisningen gir en skrivebeskyttet, tekstbasert visning av ditt komplette GraphQL-skjema, mens skjemautforskeren i venstre panel lar deg navigere, inspisere og endre objektene som vises gjennom API-et ditt. Sammen hjelper disse verktøyene deg med å forstå API-ens struktur og kontrollere hvilke data som er tilgjengelige for kundene.

Hvem bruker skjemavisningen

Skjemavisningen og utforskeren er verdifulle for:

  • Dataingeniører som konfigurerer hvilke Fabric-lakehouse- og warehouse-objekter som skal eksponeres gjennom GraphQL
  • Applikasjonsutviklere oppdager tilgjengelige Fabric-datatyper, felt og relasjoner før de skriver spørringer
  • Bidragsytere til Fabric-arbeidsområdet forstår og administrerer datatilgangsstrukturen for sitt arbeidsområde
  • BI-utviklere som gjennomgår Fabric-datarelasjoner når de bygger tilpassede analyseapplikasjoner

Bruk skjemavisningen for å utforske API-ets struktur og skjemautforskeren for å endre hvilke dataobjekter som er eksponert.

Få tilgang til og utforsk skjemaet

Du kan få tilgang til skjemavisningen enten fra spørringseditoren eller direkte fra ditt GraphQL API-element. For å åpne skjemavisningen, velg Skjema nederst til venstre. Skjemavisningen viser en skrivebeskyttet, tekstbasert versjon av din komplette GraphQL SDL med alle genererte typer, felt, spørringer og mutasjoner.

Følgende bilde viser skjemavisningen med Skjema-utforskerpanelet til venstre:

Skjermbilde av skjermbildet API-skjemavisning, som inkluderer skjemautforskeren i ruten til venstre.

Skjemautforskeren i venstre panel lar deg navigere og inspisere alle objektene i API-et ditt. Utforskeren er tilgjengelig både i skjemavisningen og i spørringseditoren, noe som gjør det enkelt å utforske API-strukturen mens du skriver spørringer.

Utvid nodene i skjemautforskeren for å se:

  • Typer: GraphQL-typene generert fra dine datakildetabeller og visninger
  • Spørringer: Automatisk genererte leseoperasjoner for å hente data
  • Mutasjoner: Automatisk genererte skriveoperasjoner for å opprette, oppdatere og slette data (kun lager)

Typer

Typene representerer strukturen til dataene dine og vises under navnet på datakilden de ble generert fra. Følgende bilde viser SalesOrderDetail-typen generert fra SalesOrderDetail-tabellen i AdventureWorks SQL-analyseendepunktet:

Skjermbilde av Skjemautforsker-ruten, som viser den utvidede listen over typer som er tilgjengelige under en eksempeldatakilde kalt SalesOrderDetail.

Spørringer

API-et genererer automatisk spørringer for å hente data fra objektene du eksponerer. Utvid spørringsnoden for å se alle tilgjengelige leseoperasjoner:

Skjermbilde av Skjemautforsker-ruten, som viser en utvidet liste over automatisk genererte spørringer.

Mutasjoner

Mutasjoner er skriveoperasjoner for å opprette, oppdatere og slette data. Utvid mutasjonsnoden for å se alle tilgjengelige skriveoperasjoner:

Skjermbilde av Skjemautforsker-ruten, som viser en utvidet liste over automatisk genererte mutasjoner.

Merk

Mutasjoner genereres kun for Fabric Data Warehouse-datakilder. SQL Analytics Endpoints (Lakehouses og speilede databaser) er skrivebeskyttet og støtter kun spørringer. Hvis du ikke ser mutasjoner i Schema-utforskeren din, verifiser du at du har koblet til et Fabric Data Warehouse.

Endre objekter ved hjelp av skjemautforskeren

Etter at API-et har generert ditt opprinnelige skjema, kan du bruke skjemautforskeren til å finjustere det som er eksponert gjennom API-et ditt. Skjemautforskeren tilbyr administrasjonsmuligheter som lar deg kontrollere API-ets struktur uten å endre de underliggende datakildene. Disse verktøyene er essensielle for å opprettholde et rent, godt organisert API som kun eksponerer dataene kundene dine trenger.

Tilgangsmodifikasjonsalternativer

For å endre et objekt, velg ellipsen (...) ved siden av en hvilken som helst type i skjemautforskeren. Følgende eksempel viser endringsmenyen for typen SalesOrderDetail :

Skjermbilde av skjemautforskeren med ellipsen valgt, som viser de tilgjengelige menyalternativene.

Tilgjengelige modifikasjonsalternativer

Oppdater skjema – Synkroniserer GraphQL-skjemaet ditt med den nyeste strukturen fra datakilden. Bruk dette når du har lagt til nye tabeller, visninger eller kolonner i datakilden din og ønsker å eksponere dem gjennom API-et. Denne operasjonen oppdager og legger til nye objekter samtidig som din eksisterende konfigurasjon bevares.

Endre navn – Endrer hvordan objektet vises i GraphQL-API-et ditt. Dette er nyttig for å lage mer intuitive API-navnekonvensjoner eller skjule implementasjonsdetaljer for klienter. For eksempel kan du bare gi nytt navn tbl_SalesOrderDetail til SalesOrderDetail. Omdøpingen påvirker kun API-skjemaet og endrer ikke det underliggende datakildeobjektet.

Fjern fra skjema – Fjerner objektet fra GraphQL-API-et ditt, slik at det ikke lenger er tilgjengelig for klienter. Bruk dette til å skjule sensitiv data, fjerne utdaterte objekter, eller forenkle API-overflaten din. Dataene forblir i din datakilde; kun API-eksponeringen fjernes.

Administrer relasjoner – Åpner relasjonsadministrasjonsgrensesnittet hvor du kan definere hvordan objekter kobles til hverandre. Relasjoner muliggjør nestede spørringer og graftraversering, slik at klienter kan hente relaterte data i én enkelt forespørsel. Hvis du vil ha mer informasjon, kan du se Administrere relasjoner i Fabric API for GraphQL.

Egenskaper - Viser detaljert metadata om objektet, inkludert det opprinnelige navnet slik det vises i datakilden, GraphQL-typenavnet, eieren og lokasjonen (arbeidsområde og datakildenavn). Bruk dette for å verifisere hvordan objektene er kartlagt mellom datakilden din og GraphQL API-et.

Aktivere og deaktivere spørringer og mutasjoner

Funksjonen for å aktivere eller deaktivere for spørringer og mutasjoner gir administratorer og utviklere detaljert kontroll over API-tilgang og -bruk. Den lar deg selektivt aktivere eller deaktivere bestemte spørringer og mutasjoner i GraphQL-skjemaet. Dette lar deg administrere API-funksjoner dynamisk uten å endre kode eller distribuere endringer.

Bruk denne funksjonen for scenarioer som:

  • API-versjonering: Deaktiver utdaterte operasjoner mens klienter overføres til nye versjoner
  • Vedlikeholdsvinduer: Deaktiver midlertidig skriveoperasjoner (mutasjoner) under datavedlikehold
  • Sikkerhet og etterlevelse: Begrens tilgangen til sensitive operasjoner uten å fjerne dem fra skjemaet
  • Trinnvise utrullinger: Aktiver nye søk eller mutasjoner for testing før de gjøres bredt tilgjengelige

Spørringer og mutasjoner i skjemautforskeren har to andre alternativer:

  • Deaktiver: Hindrer at forespørsler kjører spørringen eller mutasjonen. Hvis kjøring er forsøkt, returneres en feil. Når en spørring eller mutasjon er deaktivert, skjer det en ny innlasting av skjemaet, og spørringen eller mutasjonen vises nedtonet i skjemautforskeren.

Skjermbilde av deaktiveringsspørring eller mutasjonsalternativ vist i skjemautforsker.

  • Aktiver: Lar deg aktivere en tidligere deaktivert spørring eller mutasjon på nytt. Spørringen eller mutasjonen er umiddelbart tilgjengelig etter skjemainnlastingsoperasjonen som skjer når du velger alternativet Aktiver .

Skjermbilde av alternativet for aktivering av mutasjonsspørring vist i skjemautforskeren.

Merk

Spørringer og mutasjoner som autogenereres fra lagrede prosedyrer oppfører seg annerledes enn de som genereres fra tabeller eller visninger. De kan bare slettes, ikke deaktiveres. Etter sletting kan du legge dem til igjen ved å bruke Get Data eller Update Schema-alternativene . For mer informasjon, se Lagrede prosedyrer.

Relatert innhold

  • Last updated on