Fabric API for GraphQL-skjemavisning og Skjemautforsker
GraphQL-skjemaet, som er basert på GraphQL Schema Definition Language (SDL), definerer formatet til dataene som vises i API-en. Det er et abstraksjonslag som gir fleksibilitet til forbrukerne, samtidig som du skjuler implementeringsdetaljer for serverdel. Skjemaet er basert på en samling objekttyper som inneholder felt.
skjemavisning
Du kan få tilgang til skjemavisningen ved å velge Skjema nederst til venstre på datautviklingsskjermbildet. Visningen viser en tekstbasert versjon av GraphQL SDL med genererte typer, felt og operasjoner.
Bildet nedenfor er et eksempel på skjemavisningen, inkludert en omfattende liste over objekter som er tilgjengelige i dette skjemaet.
Merk
Skjemavisningen er skrivebeskyttet. Du kan bare endre objekter i skjemautforskeren.
Skjemautforsker
Skjemautforskeren er plassert i ruten til venstre, og er også tilgjengelig når du bruker redigeringsprogrammet i spørringsvisningen. Utforskeren gjør det mulig for brukere raskt å visualisere de tilgjengelige typene og feltene, samt spørringer og mutasjoner, definert i API-en.
Alle GraphQL-typene som er tilgjengelige fra objektene du velger når du kobler til en datakilde, vises i skjemautforskerlisten. Typene vises under navnet på datakilden de ble avledet fra. I illustrasjonen nedenfor ser du SalesOrderDetail-typen avledet fra SalesOrderDetail-tabellen i AdventureWorks SQL Analytics-endepunktet.
I tillegg til typer genererer Fabric API for GraphQL automatisk spørringer og mutasjoner for eventuelle nye objekter du velger å eksponere.
I vårt AdventureWorks-eksempel viser utvidelse av listen over spørringer de automatisk genererte spørringene for datakilden.
Hvis du vil se mutasjonene som genereres automatisk av API-en, utvider du mutasjonsnoden i skjemautforskertreet .
Endre objekter ved hjelp av skjemautforskeren
Du kan bruke skjemautforskeren til å endre objekter etter at API-en oppretter dem for deg. I eksemplet nedenfor velger vi ellipsen ved siden av SalesOrderDetail-typen som er avledet fra AdventureWorks-databasen:
Følgende alternativer er tilgjengelige for typer:
- Oppdater skjema – Lar deg oppdatere skjemaet med nye objekter fra datakilden.
- Gi nytt navn – Endrer navnet på objektet. OBS! Denne endringen påvirker bare API-skjemaet, og har ingen innvirkning på det opprinnelige datakildeobjektet som det ble avledet fra.
- Fjern fra skjema – Sletter objektet effektivt fra GraphQL-skjemaet, slik at du ikke lenger kan referere til det.
- Administrer relasjoner – Tar deg til relasjonsbehandlingsopplevelsen . Hvis du vil ha mer informasjon, kan du se Administrere relasjoner i Fabric API for GraphQL.
- Egenskaper – Viser tilleggsinformasjon om objektet.
Aktivere og deaktivere spørringer og mutasjoner
Funksjonen aktiver/deaktiver 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.
Spørringer og mutasjoner i skjemautforskeren har to ekstra alternativer:
- Deaktiver – hindrer at forespørsler utfører spørringen eller mutasjonen. Hvis kjøring er forsøkt, returneres en feil. Når en spørring eller en mutasjon er deaktivert, oppstår en skjemainnlasting på nytt, og spørringen eller mutasjonen vises nedtonet i skjemautforskeren.
- Aktiver - Aktiver en tidligere deaktivert spørring eller mutasjon på nytt. Kjøring av elementet er umiddelbart tilgjengelig ved skjemainnlastingsoperasjon som finner sted etter at du har valgt alternativet Aktiver .
Vær oppmerksom på at spørringer eller mutasjoner som genereres automatisk fra lagrede prosedyrer, bare kan slettes. Når de er slettet, kan de legges til på nytt ved hjelp av hent data eller oppdateringsskjemaalternativene .