Sdílet prostřednictvím


Vytvoření rozhraní API pro GraphQL v prostředcích infrastruktury a přidání dat

Začněte s rozhraním API Fabric pro GraphQL vytvořením rozhraní API a následným propojením zdroje dat a zveřejněním dat, která jste zvolili prostřednictvím rozhraní API. Prostředky infrastruktury sestavují schéma GraphQL automaticky na základě vašich dat a aplikace jsou připravené k připojení v řádu minut.

Kdo by měl vytvářet rozhraní GraphQL API

Vytváření rozhraní GraphQL API ve Fabric je určené pro:

  • Datoví inženýři využívající moderní API rozhraní k vystavování dat z Fabric lakehouse a skladu pro využití aplikacemi.
  • Přispěvatelé pracovních prostorů Fabricu, kteří chtějí rychle vytvářet rozhraní API pro přístup k datům bez psaní backendového kódu
  • Vývojáři BI vytvářející vlastní analytické aplikace, které potřebují programový přístup k datům Fabric
  • Vývojáři integrace vytvářející vrstvy přístupu k datům pro vlastní aplikace a automatizované pracovní postupy
  • Vývojové týmy , které dávají přednost flexibilnímu a typově bezpečnému přístupu GraphQL před přímými databázovými připojeními

Použijte tuto příručku, když potřebujete vytvořit nové rozhraní GraphQL API, které zpřístupňuje data z vašeho lakehouse Fabric, skladu nebo databáze pro aplikace.

Požadavky

K vytvoření rozhraní API pro GraphQL potřebujete:

Vaše oprávnění:

  • Buďte členem pracovního prostoru Fabric, ve kterém chcete rozhraní API vytvořit.
  • Mít v daném pracovním prostoru alespoň roli Přispěvatel (nebo vyšší: správce, člen)

Organizační nastavení:

  • Správce Fabric nebo správce kapacity musí povolit nastavení tenanta, aby uživatelé mohli vytvářet položky Fabric.

    Snímek obrazovky s nastavením tenanta a možností, kde povolit možnost Uživatelé mohou vytvářet položky Fabric

  • Pracovní prostor musí být podpořen kapacitou Fabric (Premium, zkušební nebo Fabric kapacitou).

Přístup ke zdroji dat (pro pozdější kroky):

  • Čtení oprávnění ke zdrojům dat, které plánujete zveřejnit prostřednictvím rozhraní GraphQL API
  • Oprávnění je možné udělit prostřednictvím členství v pracovním prostoru nebo přímými oprávněními ke zdroji dat.
  • V této příručce jako příklad zdroje dat používáme koncový bod analýzy SQL AdventureWorks propojený se zrcadlenou databází. Pokud chcete získat ukázková data AdventureWorks, přečtěte si téma Načtení ukázkových dat AdventureWorks v databázi SQL.

Vytvoření rozhraní API pro GraphQL

Vytvoření rozhraní API pro GraphQL:

  1. Přejděte na portál https://fabric.microsoft.com Fabric a přihlaste se pomocí účtu organizace.

  2. Vyberte pracovní prostor, ve kterém chcete rozhraní API vytvořit, a pak vyberte Nová položka. Na panelu, který se otevře, vyberte v části Vývoj datmožnost API pro GraphQL.

    Snímek obrazovky s panelem nástrojů pracovního prostoru, který ukazuje, kde vybrat možnost 'Nový'.

  3. Zadejte název nového rozhraní API pro položku GraphQL a vyberte Vytvořit.

Teď máte aktivní koncový bod rozhraní GraphQL API ve Fabric. V tuto chvíli můžete zkopírovat adresu URL koncového bodu z portálu Fabric, vybrat Vygenerovat kód , abyste získali ukázky kódu a rozhraní API je připravené přijímat požadavky. V další části připojíme zdroje dat k sestavení vašeho schématu, ale samotný koncový bod je už funkční.

Připojení ke zdroji dat a sestavení schématu

V tuto chvíli je koncový bod rozhraní API připravený, ale zatím nezpřístupňuje žádná data. Rozhraní API pro GraphQL jsou definována ve schématu uspořádané z hlediska typů a polí v systému silného typu. Prostředky infrastruktury automaticky generují potřebné schéma GraphQL na základě dat, která se rozhodnete zpřístupnit klientům GraphQL.

Připojení zdroje dat a sestavení schématu:

  1. Ujistěte se, že jste ve svém pracovním prostoru vybrali novou položku rozhraní GraphQL API.

  2. V části Přidat data do rozhraní API pro GraphQL vyberte dlaždici Vybrat zdroj dat .

    Snímek obrazovky s dlaždicí pro výběr zdroje dat

  3. Dále vyberte možnost připojení pro vaše rozhraní API:

    Snímek obrazovky s oknem Zvolit možnosti připojení

    Tady můžete definovat, jak můžou klienti rozhraní API přistupovat k rozhraní API a spouštět požadavky GraphQL na základě dvou různých možností:

    • Jednotné přihlašování: Pro připojení ke zdrojům dat můžete použít přihlašovací údaje klienta. Ověřený uživatel rozhraní API musí mít přístup k podkladovým tabulkám ve zdroji dat.

      Pokud například vystavujete data Lakehouse klientům rozhraní API, musí ověřený uživatel mít přístup k rozhraní API i k Lakehouse. Konkrétně oprávnění ke spuštění k rozhraní GraphQL API (možnost spuštění dotazů a mutací při přidávání oprávnění přímého přístupu) a oprávnění ke čtení nebo zápisu vyžadovaná ve vybraném zdroji dat. Alternativně můžete uživatele přidat jako člena pracovního prostoru s rolí přispěvatele , kde se nachází rozhraní API i položky zdroje dat, které poskytují požadovaný přístup k oběma položkám z jednoho umístění. Další informace najdete v tématu Udělení přístupu uživatelům k pracovním prostorům.

    • Uložené přihlašovací údaje: Uložené přihlašovací údaje můžete použít k připojení ke zdrojům dat. Ověřený uživatel rozhraní API nepotřebuje přímý přístup k datům. Uložené přihlašovací údaje se sdílejí pro přístup k datům mezi rozhraním API a podkladovými tabulkami ve zdroji dat.

      Pokud například vystavujete data Lakehouse klientům rozhraní API, musí mít ověřený uživatel pouze přímý přístup k rozhraní API (možnost Spustit dotazy a změny při přidávání oprávnění přímého přístupu) a ne k Lakehouse. Uložené přihlašovací údaje slouží k připojení rozhraní API ke zdroji dat a jsou sdíleny všemi ověřenými uživateli rozhraní API. Tato možnost se vyžaduje, pokud vytváříte zdroj dat Azure, jako je databáze Azure SQL prostřednictvím GraphQL.

    Po výběru se tyto možnosti vynucují pro všechny zdroje dat později přidané do rozhraní API. Není možné kombinovat jednotné přihlašování a uložené přihlašovací údaje ve stejném rozhraní API. Hlavní názvy uživatelů (UPN) nebo hlavní názvy služby (SPN) můžete použít k připojení k rozhraní API pomocí jednotného přihlašování nebo uložených přihlašovacích údajů v závislosti na požadavcích na zabezpečení.

    Podrobný rozpis požadavků na oprávnění pro různé scénáře ověřování najdete v části Souhrn ověřování a oprávnění.

    Poznámka:

    Rozhraní API pro GraphQL vyžaduje, aby klientské aplikace k ověřování používaly ID Microsoft Entra. Vaše klientská aplikace musí být zaregistrovaná a nakonfigurovaná adekvátně, aby bylo možné spouštět volání rozhraní API proti prostředkům infrastruktury. Aplikace zaregistrovaná v Microsoft Entra ID vyžaduje pro službu Power BI oprávnění GraphQLApi.Execute.All API. Kompletní kurz s pokyny a vzorovým kódem pro instanční objekty i instanční objekty najdete v aplikaci Connect Applications.

  4. V katalogu OneLake zvolte zdroj dat, ke kterému se chcete připojit. Výběrem možnosti Filtr zobrazíte pouze konkrétní typy zdrojů dat infrastruktury nebo můžete hledat podle konkrétního klíčového slova. Až budete připraveni, vyberte Připojit.

    Snímek obrazovky s datovým centrem OneLake zobrazující dostupné možnosti zdroje dat pro pracovní prostor

    V tomto příkladu jsme zvolili koncový bod analýzy SQL propojený se zrcadlenou databází, která obsahuje ukázková data AdventureWorks.

  5. Pokud jste dříve vybrali Uložené přihlašovací údaje a pro rozhraní GraphQL API ještě nejsou uložené přihlašovací údaje, zobrazí se výzva k vytvoření nových uložených přihlašovacích údajů.

  6. Zobrazí se stránka Zvolit data , kde můžete zvolit objekty, které chcete zobrazit ve schématu GraphQL.

  7. Zaškrtněte políčka vedle jednotlivých tabulek, zobrazení nebo uložených procedur, které chcete zpřístupnit v rozhraní API. Pokud chcete vybrat všechny objekty ve složce, zaškrtněte políčko s názvem zdroje dat v horní části.

    Snímek obrazovky Průzkumníka dat s vybranou složkou, která automaticky vybere všechny položky v této složce

  8. Výběrem možnosti Načíst spustíte proces generování schématu GraphQL.

  9. Schéma se vygeneruje a můžete začít vytvářet prototypy dotazů GraphQL (čtení, seznam) nebo mutací (vytváření, aktualizace, odstranění) pro interakci s daty.

    Snímek obrazovky Průzkumníka schématu

    Návod

    Pokud chcete získat návrhy při psaní dotazů v editoru, zadejte Ctrl/Cmd + mezerník.

    Další informace o použití editoru rozhraní API najdete v tématu Rozhraní FABRIC API pro editor GraphQL.

Shrnutí

A je to! Úspěšně jste vytvořili GraphQL API ve Fabric, připojili zdroj dat a vygenerovali schéma. Vaše rozhraní API je teď připravené přijímat připojení a požadavky z klientských aplikací. Pomocí editoru rozhraní API můžete testovat a prototypovat dotazy GraphQL a pomocí Průzkumníka schémat ověřte datové typy a pole vystavená v rozhraní API.