Interfejs API sieci szkieletowej dla widoku schematu graphQL i Eksplorator schematu
Uwaga
Interfejs API usługi Microsoft Fabric dla języka GraphQL jest w wersji zapoznawczej.
Schemat GraphQL oparty na języku GraphQL Schema Definition Language (SDL) definiuje format danych uwidocznionych w interfejsie API. Jest to warstwa abstrakcji, która zapewnia elastyczność użytkownikom podczas ukrywania szczegółów implementacji zaplecza. Schemat jest oparty na kolekcji typów obiektów, które zawierają pola.
Widok schematu
Aby uzyskać dostęp do widoku schematu, wybierz pozycję Schemat w lewym dolnym rogu ekranu Tworzenie danych. Widok przedstawia wersję tekstową języka SDL programu GraphQL z wygenerowanymi typami, polami i operacjami.
Na poniższej ilustracji przedstawiono przykład widoku schematu, w tym obszerną listę obiektów dostępnych w tym schemacie.
Uwaga
Widok schematu jest tylko do odczytu. Obiekty można modyfikować tylko w Eksploratorze schematów.
Eksplorator schematu
Eksplorator schematu znajduje się w okienku po lewej stronie i jest również dostępny podczas korzystania z edytora w widoku zapytania. Eksplorator umożliwia użytkownikom szybkie wizualizowanie dostępnych typów i pól, a także zapytań i mutacji zdefiniowanych w interfejsie API.
Wszystkie typy GraphQL, które są dostępne w obiektach wybieranych podczas nawiązywania połączenia ze źródłem danych, są wyświetlane na liście Eksplorator schematów. Typy są wyświetlane pod nazwą źródła danych, z którego pochodzą. Na poniższej ilustracji zobaczysz typ SalesOrderDetail pochodzący z tabeli SalesOrderDetail w punkcie końcowym analizy SQL AdventureWorks .
Oprócz typów interfejs API sieci szkieletowej dla programu GraphQL automatycznie generuje zapytania i mutacje dla wszystkich nowych obiektów, które chcesz uwidocznić.
W naszym przykładzie AdventureWorks rozwinięcie listy zapytań powoduje wyświetlenie automatycznie wygenerowanych zapytań dla źródła danych.
Aby zobaczyć mutacje generowane automatycznie przez interfejs API, rozwiń węzeł mutacji w drzewie Eksplorator schematu.
Modyfikowanie obiektów przy użyciu Eksploratora schematów
Eksplorator schematu umożliwia modyfikowanie obiektów po utworzeniu ich przez interfejs API. W poniższym przykładzie wybieramy wielokropek obok typu SalesOrderDetail pochodzącego z bazy danych AdventureWorks :
Dostępne są następujące opcje dla typów:
- Aktualizowanie schematu — umożliwia aktualizowanie schematu przy użyciu nowych obiektów ze źródła danych.
- Zmień nazwę — zmienia nazwę obiektu. UWAGA: Ta zmiana dotyczy tylko schematu interfejsu API i nie ma wpływu na oryginalny obiekt źródła danych, z którego pochodzi.
- Usuń ze schematu — skutecznie usuwa obiekt ze schematu GraphQL, aby nie można już się do niego odwoływać.
- Zarządzanie relacjami — umożliwia zarządzanie relacjami. Aby uzyskać więcej informacji, zobacz Zarządzanie relacjami w interfejsie API sieci szkieletowej dla języka GraphQL.
- Właściwości — wyświetla dodatkowe informacje o obiekcie.
Włączanie i wyłączanie zapytań i mutacji
Funkcja włączania/wyłączania zapytań i mutacji zapewnia administratorom i deweloperom szczegółową kontrolę nad dostępem i użyciem interfejsu API. Umożliwia selektywne aktywowanie lub dezaktywowanie określonych zapytań i mutacji w schemacie GraphQL. Umożliwia to dynamiczne zarządzanie możliwościami interfejsu API bez modyfikowania kodu lub wdrażania zmian.
Zapytania i mutacje w eksploratorze schematów mają dwie dodatkowe opcje:
- Wyłącz — uniemożliwia wykonywanie zapytania lub mutacji wszystkich żądań. Jeśli próba wykonania zostanie podjęta, zostanie zwrócony błąd. Po wyłączeniu zapytania lub mutacji następuje ponowne ładowanie schematu, a zapytanie lub mutacja pojawiają się wyszarydzone w Eksploratorze schematów.
- Włącz — ponownie włącz wcześniej wyłączone zapytanie lub mutację. Wykonanie elementu jest natychmiast dostępne po operacji ponownego ładowania schematu, która odbywa się po wybraniu opcji Włącz .
Należy pamiętać, że zapytania lub mutacje generowane automatycznie na podstawie procedur składowanych można usunąć tylko. Po usunięciu można je ponownie dodać przy użyciu opcji Pobierz dane lub Aktualizuj schemat .