Del via

Fabric API til GraphQL-skemavisning og Skemaoversigt

  • Artikel

GraphQL-skemaet, der er baseret på SDL (GraphQL Schema Definition Language), definerer formatet af de data, der vises i API'en. Det er et abstraktionslag, der giver fleksibilitet til forbrugerne, samtidig med at detaljer om backendimplementering skjules. Skemaet er baseret på en samling af objekttyper, der indeholder felter.

Skemavisning

Du kan få adgang til skemavisningen ved at vælge Skema nederst til venstre på skærmen Dataudvikling. Visningen viser en tekstbaseret version af GraphQL SDL med genererede typer, felter og handlinger.

Følgende billede er et eksempel på skemavisningen, herunder en omfattende liste over objekter, der er tilgængelige i dette skema.

Bemærk

Skemavisningen er skrivebeskyttet. Du kan kun redigere objekter i Skemaoversigt.

Skærmbillede af skærmbilledet med API-skemavisning, som omfatter Skemaoversigt i ruden til venstre.

Skemaoversigt

Skemaoversigten er placeret i ruden til venstre og er også tilgængelig, når du bruger editoren i forespørgselsvisningen. Stifinderen giver brugerne mulighed for hurtigt at visualisere de tilgængelige typer og felter samt forespørgsler og mutationer, der er defineret i API'en.

Alle de GraphQL-typer, der er tilgængelige fra de objekter, du vælger, når du opretter forbindelse til en datakilde, vises på listen Skemaoversigt. Typerne vises under navnet på den datakilde, de er afledt af. På følgende billede kan du se typen SalesOrderDetail , der er afledt af tabellen SalesOrderDetail i slutpunktet for AdventureWorks SQL-analyse.

Skærmbillede af ruden Skemaoversigt, der viser den udvidede liste over typer, der er tilgængelige under en eksempeldatakilde med navnet SalesOrderDetail.

Ud over typer genererer Fabric API til GraphQL automatisk forespørgsler og mutationer for alle nye objekter, du vælger at eksponere.

I eksemplet adventureworks viser udvidelse af listen over forespørgsler de automatisk genererede forespørgsler for datakilden.

Skærmbillede af ruden Skemaoversigt, der viser en udvidet liste over automatisk genererede forespørgsler.

Hvis du vil se de mutationer, der genereres automatisk af API'en, skal du udvide mutationsnoden i træet Skemaoversigt .

Skærmbillede af ruden Skemaoversigt, der viser en udvidet liste over automatisk genererede mutationer.

Rediger objekter ved hjælp af Skemaoversigt

Du kan bruge Skemaoversigt til at redigere objekter, når API'en har oprettet dem for dig. I følgende eksempel vælger vi ellipsen ud for typen SalesOrderDetail , der er afledt af vores AdventureWorks-database :

Skærmbillede af Skemaoversigt, hvor ellipsen er valgt, og som viser de tilgængelige menuindstillinger.

Følgende indstillinger er tilgængelige for Typer:

  • Opdater skema – giver dig mulighed for at opdatere skemaet med nye objekter fra datakilden.
  • Rename – ændrer navnet på objektet. BEMÆRK! Denne ændring påvirker kun API-skemaet og har ingen indvirkning på det oprindelige datakildeobjekt, som det blev afledt af.
  • Fjern fra skema – sletter objektet effektivt fra GraphQL-skemaet, så du ikke længere kan referere til det.
  • Administrer relationer – fører dig til relationsadministrationsoplevelsen. Du kan få flere oplysninger under Administrer relationer i Fabric API til GraphQL.
  • Properties – Viser yderligere oplysninger om objektet.

Aktivér og deaktiver forespørgsler og mutationer

Funktionen enable/disable for forespørgsler og mutationer giver administratorer og udviklere detaljeret kontrol over API-adgang og -brug. Det giver dig mulighed for selektivt at aktivere eller deaktivere specifikke forespørgsler og mutationer i GraphQL-skemaet. Dette giver dig mulighed for at administrere API-funktioner dynamisk uden at ændre kode eller udrulle ændringer.

Forespørgsler og mutationer i skemaoversigten har to yderligere muligheder:

  • Disable – forhindrer alle anmodninger i at udføre forespørgslen eller mutationen. Hvis udførelse forsøges, returneres der en fejl. Når en forespørgsel eller en mutation er deaktiveret, sker der en genindlæsning af et skema, og forespørgslen eller mutationen vises nedtonet i skemaoversigten.

Skærmbillede af indstillingen deaktiver forespørgsel eller mutation, der vises i skemaoversigten.

  • Enable – Genaktiver en tidligere deaktiveret forespørgsel eller mutation. Udførelsen af elementet er umiddelbart tilgængelig ved genindlæsningshandlingen for skemaet, der finder sted, når du har valgt indstillingen Aktivér .

Skærmbillede af indstillingen Aktivér forespørgsel om mutation, der vises i skemaoversigten.

Bemærk, at forespørgsler eller mutationer, der genereres automatisk fra lagrede procedurer, kun kan slettes. Når de er slettet, kan de tilføjes igen ved hjælp af indstillingerne Hent data eller Opdater skema .

Relateret indhold