Share via

Fabric-API voor GraphQL-schemaweergave en schemaverkenner

Het GraphQL-schema, op basis van de GraphQL Schema Definition Language (SDL), definieert de indeling van de gegevens die worden weergegeven in de API. Het biedt gebruikers flexibiliteit tijdens het verbergen van details van de back-end-implementatie. Het schema maakt gebruik van een verzameling objecttypen die velden bevatten.

Schemaweergave

Open de schemaweergave door Schema in de linkerbenedenhoek van het scherm Gegevensontwikkeling te selecteren. In deze weergave ziet u een op tekst gebaseerde versie van graphQL SDL met gegenereerde typen, velden en bewerkingen.

In de volgende afbeelding ziet u een voorbeeld van de schemaweergave, inclusief een lijst met objecten die beschikbaar zijn in dit schema.

Notitie

De schemaweergave heeft het kenmerk Alleen-lezen. Wijzig alleen objecten in de schemaverkenner.

Schermopname van het scherm voor de API-schemaweergave, met schemaverkenner in het linkerdeelvenster.

Schemaverkenner

De Schemaverkenner bevindt zich in het deelvenster aan de linkerkant en is ook beschikbaar wanneer u de editor in de queryweergave gebruikt. Met de verkenner kunnen gebruikers snel de beschikbare typen en velden visualiseren, evenals query's en mutaties die in de API zijn gedefinieerd.

Alle GraphQL-typen die beschikbaar zijn in de objecten die u kiest wanneer u verbinding maakt met een gegevensbron, worden weergegeven in de lijst schemaverkenner. De typen worden weergegeven onder de naam van de gegevensbron waaruit ze zijn afgeleid. In de volgende afbeelding ziet u het type SalesOrderDetail dat is afgeleid van de tabel SalesOrderDetail in het eindpunt van AdventureWorks SQL Analytics.

Schermopname van het deelvenster Schemaverkenner met de uitgebreide lijst met beschikbare typen onder een voorbeeldgegevensbron met de naam SalesOrderDetail.

Naast typen genereert de Fabric-API voor GraphQL automatisch query's en mutaties voor nieuwe objecten die u beschikbaar wilt maken.

In ons AdventureWorks-voorbeeld toont het uitbreiden van de lijst met query's de automatisch gegenereerde query's voor de gegevensbron.

Schermopname van het deelvenster Schemaverkenner met een uitgebreide lijst met automatisch gegenereerde query's.

Breid het mutatieknooppunt uit in de schemaverkennerstructuur om de mutaties te zien die automatisch door de API worden gegenereerd.

Schermopname van het deelvenster Schemaverkenner met een uitgebreide lijst met automatisch gegenereerde mutaties.

Objecten wijzigen met behulp van schemaverkenner

U kunt schemaverkenner gebruiken om objecten te wijzigen nadat de API ze voor u heeft gemaakt. In het volgende voorbeeld selecteren we het beletselteken naast het type SalesOrderDetail dat is afgeleid van onze AdventureWorks-database :

Schermopname van de schemaverkenner met het beletselteken geselecteerd, met de beschikbare menuopties.

De volgende opties zijn beschikbaar voor Typen:

  • Schema bijwerken : hiermee kunt u het schema bijwerken met nieuwe objecten uit de gegevensbron.

  • Naam wijzigen : hiermee wijzigt u de naam van het object. Deze wijziging is alleen van invloed op het API-schema en heeft geen invloed op het oorspronkelijke gegevensbronobject waaruit het is afgeleid.

  • Verwijderen uit schema : hiermee verwijdert u het object uit het GraphQL-schema, zodat u er niet meer naar kunt verwijzen.

  • Relaties beheren - Hiermee opent u de ervaring voor relatiebeheer. Zie Relaties beheren in Fabric-API voor GraphQL voor meer informatie.

  • Eigenschappen : geeft aanvullende informatie over het object weer.

Query's en mutaties in- en uitschakelen

De functie voor het in- of uitschakelen van query's en mutaties biedt beheerders en ontwikkelaars gedetailleerde controle over API-toegang en -gebruik. Hiermee kunt u selectief specifieke query's en mutaties in het GraphQL-schema activeren of deactiveren. Hiermee kunt u API-mogelijkheden dynamisch beheren zonder code te wijzigen of wijzigingen te implementeren.

Query's en mutaties in de schemaverkenner hebben twee andere opties:

  • Uitschakelen: Hiermee voorkomt u dat er verzoeken gestart worden die de query of mutatie uitvoeren. Als er een poging wordt uitgevoerd, wordt er een fout geretourneerd. Nadat een query of mutatie is uitgeschakeld, wordt een schema opnieuw geladen en wordt de query of mutatie grijs weergegeven in de schemaverkenner.

Schermopname van de optie query of mutatie uitschakelen die wordt weergegeven in schemaverkenner.

  • Inschakelen: Hiermee kunt u een eerder uitgeschakelde query of mutatie opnieuw inschakelen. De query of mutatie is onmiddellijk beschikbaar na het herladen van het schema dat optreedt wanneer u de optie Inschakelen selecteert.

Schermopname van het inschakelen van de queryfunctie van de mutatieoptie die wordt weergegeven in de schema-explorer.

Queries of mutaties die automatisch vanuit opgeslagen procedures worden gegenereerd, kunnen alleen worden verwijderd. Na verwijdering kunnen ze worden gelezen met behulp van de opties Gegevens ophalen of Schema bijwerken .

Gerelateerde inhoud

  • Last updated on