Udostępnij przez

Tworzenie interfejsu API dla języka GraphQL w sieci szkieletowej i dodawanie danych

Rozpocznij pracę z interfejsem API sieci szkieletowej dla języka GraphQL, tworząc interfejs API, a następnie łącząc źródło danych, aby uwidocznić dane wybrane za pośrednictwem interfejsu API. Sieć szkieletowa tworzy schemat GraphQL automatycznie na podstawie danych, a aplikacje są gotowe do nawiązania połączenia w ciągu kilku minut.

Kto powinien tworzyć GraphQL API

Tworzenie interfejsów API GraphQL w Fabric jest przeznaczone dla:

  • Inżynierowie danych udostępniający dane jeziora i magazynu Fabric za pomocą nowoczesnych interfejsów API do użycia w aplikacjach
  • Współautorzy Fabric workspace, którzy chcą szybko tworzyć interfejsy API dostępu do danych bez konieczności pisania kodu backendu.
  • Programiści BI tworzący niestandardowe aplikacje analityczne, które wymagają dostępu programistycznego do danych Fabric
  • Deweloperzy integracji tworzący warstwy dostępu do danych dla aplikacji niestandardowych i zautomatyzowanych przepływów pracy
  • Zespoły programistyczne, które preferują elastyczne, typowo bezpieczne podejście GraphQL zamiast bezpośrednich połączeń z bazą danych

Skorzystaj z tego przewodnika, gdy musisz utworzyć nowy interfejs API GraphQL, który udostępnia dane Twojego systemu Fabric lakehouse, hurtowni danych lub bazy danych do aplikacji.

Wymagania wstępne

Aby utworzyć interfejs API dla języka GraphQL, potrzebne są następujące elementy:

Twoje uprawnienia:

  • Zostań członkiem obszaru roboczego Fabric, gdzie chcesz utworzyć interfejs API
  • Mieć co najmniej rolę Kontrybutor w tym obszarze roboczym (lub wyższą: Administrator, Członek)

Konfiguracja organizacyjna:

  • Administrator infrastruktury lub administrator zasobów musi włączyć ustawienie dzierżawy "Użytkownicy mogą tworzyć elementy infrastruktury"

    Zrzut ekranu przedstawiający ustawienia dzierżawy i miejsce włączenia opcji Użytkownicy mogą tworzyć elementy Fabric.

  • Obszar roboczy musi być wspierany przez pojemność Fabric (pojemność Premium, wersja próbna lub pojemność Fabric)

Dostęp do źródła danych (w przypadku dalszych kroków):

  • Nadanie uprawnień do odczytu źródeł danych, które chcesz udostępnić za pośrednictwem interfejsu API GraphQL
  • Uprawnienia można przyznać za pośrednictwem członkostwa w obszarze roboczym lub bezpośrednich uprawnień do źródła danych
  • W tym przewodniku użyjemy punktu końcowego analizy SQL AdventureWorks połączonego z dublowaną bazą danych jako przykładowym źródłem danych. Aby uzyskać przykładowe dane AdventureWorks, zobacz Ładowanie przykładowych danych AdventureWorks w bazie danych SQL.

Tworzenie interfejsu API dla języka GraphQL

Aby utworzyć interfejs API dla języka GraphQL:

  1. Przejdź do portalu Fabric pod adresem https://fabric.microsoft.com i zaloguj się przy użyciu konta organizacyjnego.

  2. Wybierz obszar roboczy, w którym chcesz utworzyć interfejs API, a następnie wybierz pozycję Nowy element. W wyświetlonym panelu w obszarze Programowanie danychwybierz interfejs API dlaGraphQL.

    Zrzut ekranu przedstawiający pasek narzędzi obszaru roboczego pokazujący, gdzie wybrać opcję Nowy.

  3. Wprowadź nazwę nowego interfejsu API dla elementu GraphQL i wybierz pozycję Utwórz.

Teraz masz aktywny punkt końcowy interfejsu API GraphQL w Fabric. Na tym etapie możesz skopiować adres URL punktu końcowego z portalu sieci szkieletowej, wybrać pozycję Generuj kod , aby pobrać przykłady kodu, a interfejs API jest gotowy do odbierania żądań. W następnej sekcji połączymy źródła danych w celu skompilowania schematu, ale sam punkt końcowy jest już funkcjonalny.

Nawiązywanie połączenia ze źródłem danych i tworzenie schematu

Na tym etapie punkt końcowy interfejsu API jest gotowy, ale nie ujawnia jeszcze żadnych danych. Interfejsy API dla języka GraphQL są definiowane w schemacie zorganizowanym pod względem typów i pól w silnie typizowanym systemie. Sieć szkieletowa automatycznie generuje wymagany schemat GraphQL na podstawie danych, które mają być widoczne dla klientów GraphQL.

Aby połączyć źródło danych i skompilować schemat:

  1. Upewnij się, że wybrano nowy element interfejsu API GraphQL w obszarze roboczym.

  2. W obszarze Dodawanie danych do interfejsu API dla programu GraphQL wybierz kafelek Wybierz źródło danych .

    Zrzut ekranu przedstawiający kafelek Wybierz źródło danych.

  3. Następnie wybierz opcję łączności dla interfejsu API:

    Zrzut ekranu przedstawiający okno wybierz opcję łączności.

    W tym miejscu można zdefiniować, jak klienci interfejsu API mogą uzyskiwać dostęp do interfejsu API w celu wykonywania żądań GraphQL na podstawie dwóch odrębnych opcji:

    • Logowanie jednokrotne (SSO) : możesz nawiązać połączenie ze źródłami danych przy użyciu poświadczeń klienta. Uwierzytelniony użytkownik interfejsu API musi mieć dostęp do bazowych tabel w źródle danych.

      Jeśli na przykład udostępniasz dane usługi Lakehouse klientom interfejsu API, uwierzytelniony użytkownik musi mieć dostęp zarówno do interfejsu API, jak i usługi Lakehouse. W szczególności uprawnienia do wykonywania interfejsu API GraphQL (opcja Uruchom zapytania i mutacje podczas dodawania uprawnień dostępu bezpośredniego) i uprawnienia do odczytu lub zapisu wymagane w wybranym źródle danych. Alternatywnie użytkownik może zostać dodany jako członek obszaru roboczego z rolą współautora , w której znajdują się zarówno elementy interfejsu API, jak i źródła danych, co zapewnia wymagany dostęp do obu elementów z jednej lokalizacji. Aby uzyskać więcej informacji, zobacz Przyznawanie użytkownikom dostępu do obszarów roboczych.

    • Zapisane poświadczenia: możesz użyć zapisanych poświadczeń, aby nawiązać połączenie ze źródłami danych. Uwierzytelniony użytkownik interfejsu API nie potrzebuje bezpośredniego dostępu do danych. Zapisane poświadczenia są udostępniane w celu uzyskania dostępu do danych między interfejsem API i tabelami bazowymi w źródle danych.

      Jeśli na przykład udostępniasz dane Lakehouse klientom interfejsu API, uwierzytelniony użytkownik musi mieć tylko bezpośredni dostęp do interfejsu API (opcja Uruchom zapytania i mutacje podczas dodawania uprawnień dostępu bezpośredniego), a nie do samego Lakehouse. Zapisane poświadczenie służy do łączenia interfejsu API ze źródłem danych i jest współużytkowane przez wszystkich uwierzytelnionych użytkowników interfejsu API. Ta opcja jest wymagana, jeśli uwidaczniasz źródło danych platformy Azure, takie jak baza danych Azure SQL Database za pośrednictwem programu GraphQL.

    Po wybraniu, te opcje będą automatycznie stosowane do wszystkich źródeł danych dodawanych później do interfejsu API. Nie można mieszać logowania jednokrotnego i zapisywanych poświadczeń w tym samym interfejsie API. Aby nawiązać połączenie z interfejsem API, można użyć głównych nazw użytkownika (UPN) lub głównych nazw usług (SPN) przy użyciu logowania jednokrotnego lub zapisanych poświadczeń w zależności od wymagań dotyczących zabezpieczeń.

    Aby uzyskać szczegółowy podział wymagań dotyczących uprawnień dla różnych scenariuszy uwierzytelniania, zobacz Uwierzytelnianie i podsumowanie uprawnień.

    Uwaga

    Interfejs API dla języka GraphQL wymaga, aby aplikacje klienckie używały identyfikatora Entra firmy Microsoft do uwierzytelniania. Aplikacja kliencka musi być zarejestrowana i skonfigurowana odpowiednio do wykonywania wywołań interfejsu API w usłudze Fabric. Aplikacja zarejestrowana w usłudze Microsoft Entra ID wymaga uprawnień interfejsu API GraphQLApi.Execute.All dla usługi Power BI. Pełny samouczek zawiera instrukcje i przykładowy kod dla jednostek użytkownika i jednostek usługi w temacie Łączenie aplikacji.

  4. W katalogu OneLake wybierz źródło danych, z którym chcesz nawiązać połączenie. Wybierz pozycję Filtr , aby wyświetlić tylko określone typy źródeł danych sieci szkieletowej lub wyszukaj według określonego słowa kluczowego. Gdy wszystko będzie gotowe, wybierz pozycję Połącz.

    Zrzut ekranu przedstawiający centrum danych OneLake z dostępnymi opcjami źródła danych dla obszaru roboczego.

    W tym przykładzie wybraliśmy punkt końcowy analizy SQL połączony z dublowaną bazą danych zawierającą przykładowe dane AdventureWorks.

  5. Jeśli wcześniej wybrano pozycję Zapisane poświadczenia i jeśli nie ma już zapisanego poświadczenia dla interfejsu API graphQL, zostanie wyświetlony monit o utworzenie nowego zapisanego poświadczenia.

  6. Zostanie wyświetlona strona Wybieranie danych , na której można wybrać obiekty, które mają być uwidocznione w schemacie GraphQL.

  7. Zaznacz pola wyboru obok poszczególnych tabel, widoków lub procedur składowanych, które chcesz uwidocznić w interfejsie API. Aby zaznaczyć wszystkie obiekty w folderze, zaznacz pole wyboru z nazwą źródła danych u góry.

    Zrzut ekranu eksploratora danych z wybranym folderem, który automatycznie wybiera wszystkie elementy w tym folderze.

  8. Wybierz pozycję Załaduj , aby rozpocząć proces generowania schematu GraphQL.

  9. Schemat jest generowany i można rozpocząć tworzenie prototypów zapytań GraphQL (odczyt, lista) lub mutacje (tworzenie, aktualizowanie, usuwanie) w celu interakcji z danymi.

    Zrzut ekranu przedstawiający ekran Eksplorator schematu.

    Wskazówka

    Wprowadź Ctrl/Cmd + spacja, aby uzyskać sugestie podczas pisania zapytań w edytorze.

    Aby uzyskać więcej informacji na temat korzystania z edytora interfejsu API, zobacz Interfejs API sieci szkieletowej dla edytora GraphQL.

Podsumowanie

To wszystko! Pomyślnie utworzono API GraphQL w Fabric, połączono źródło danych i wygenerowano schemat. Interfejs API jest teraz gotowy do akceptowania połączeń i żądań z aplikacji klienckich. Edytor interfejsu API umożliwia testowanie i prototypowanie zapytań GraphQL oraz używanie Eksploratora schematów do weryfikowania typów danych i pól uwidocznionych w interfejsie API.

Powiązana zawartość

  • Last updated on