Fabric-API voor GraphQL-schemaweergave en Schemaverkenner
Het GraphQL-schema, dat is gebaseerd op de GraphQL Schema Definition Language (SDL), definieert de indeling van de gegevens die worden weergegeven in de API. Het is een abstractielaag die gebruikers flexibiliteit biedt tijdens het verbergen van de details van de back-end-implementatie. Het schema is gebaseerd op een verzameling objecttypen die velden bevatten.
Schemaweergave
U kunt de schemaweergave openen door Schema te selecteren in de linkerbenedenhoek van het scherm Gegevensontwikkeling. In de weergave ziet u een op tekst gebaseerde versie van graphQL SDL met gegenereerde typen, velden en bewerkingen.
De volgende afbeelding is een voorbeeld van de schemaweergave, waaronder een uitgebreide lijst met objecten die beschikbaar zijn in dit schema.
Notitie
De schemaweergave heeft het kenmerk Alleen-lezen. U kunt alleen objecten wijzigen in schemaverkenner.
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.
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.
Als u de mutaties wilt zien die automatisch door de API worden gegenereerd, vouwt u het mutatieknooppunt uit in de schemaverkennerstructuur .
Objecten wijzigen met 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 :
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. LET OP: 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 effectief uit het GraphQL-schema, zodat u er niet meer naar kunt verwijzen.
- Relaties beheren- Hiermee gaat u naar 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 in-/uitschakelen voor 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 extra opties:
- Uitschakelen : hiermee voorkomt u dat aanvragen de query of mutatie uitvoeren. Als er een poging wordt uitgevoerd, wordt er een fout geretourneerd. Zodra een query of mutatie is uitgeschakeld, wordt een schema opnieuw geladen en wordt de query of mutatie grijs weergegeven in de schemaverkenner.
- Inschakelen : schakel een eerder uitgeschakelde query of mutatie opnieuw in. De uitvoering van het item is onmiddellijk beschikbaar bij het opnieuw laden van het schema dat plaatsvindt nadat u de optie Inschakelen hebt geselecteerd.
Houd er rekening mee dat query's of mutaties die automatisch worden gegenereerd op basis van opgeslagen procedures alleen kunnen worden verwijderd. Zodra ze zijn verwijderd, kunnen ze opnieuw worden toegevoegd met behulp van de opties Gegevens ophalen of Schema bijwerken.