Broncodebeheer- en implementatiepijplijnen in API voor GraphQL (preview)

Meer informatie over hoe Git-integratie- en implementatiepijplijnen werken met API voor GraphQL in Microsoft Fabric. Dit artikel helpt u inzicht te hebben in het instellen van een verbinding met uw opslagplaats, het beheren van uw API voor GraphQL en het implementeren ervan in verschillende omgevingen.

Wie gebruikmaakt van broncodebeheer en -implementatie

Git-integratie- en implementatiepijplijnen zijn essentieel voor:

• Data engineers die de configuraties van de Fabric GraphQL API beheren via versiebeheer en CI/CD-werkstromen
• Fabric-werkruimtebeheerders coördineren implementaties voor ontwikkel-, test- en productie-Fabric-werkruimten
• DevOps-teams implementeren implementatiepijplijnen voor Fabric-API's in meerdere omgevingen en capaciteiten
• Platformteams waarvoor governance-, volgsysteem en rollback-functionaliteit nodig zijn voor wijzigingen in Fabric API's

Gebruik broncodebeheer en implementatiepijplijnen wanneer u GraphQL-API's moet beheren als onderdeel van een gestructureerde ontwikkelingslevenscyclus met meerdere omgevingen.

Vereiste voorwaarden

• U moet een API voor GraphQL in Fabric hebben. Zie Een API maken voor GraphQL in Fabric en gegevens toevoegenvoor meer informatie.

Overzicht

Fabric biedt krachtige hulpprogramma's voor CI/CD (continue integratie en continue implementatie) en ontwikkelingslevenscyclusbeheer via twee hoofdonderdelen: Git-integratie (CI) en implementatiepijplijnen (CD). Werkruimten fungeren als centrale onderdelen voor zowel Git-synchronisatie- als implementatiefasen.

Git-integratie (CI): synchroniseert werkruimte-items (bijvoorbeeld code, configuraties, API's) met opslagplaatsen voor versiebeheer, waardoor versiebeheer en wijzigingen bijhouden via Git mogelijk zijn.

Implementatiepijplijnen (CD): hiermee kunt u fasen maken (bijvoorbeeld Ontwikkeling, Testen, Productie) met gekoppelde werkruimten. Items die in elke fase worden ondersteund, worden automatisch gerepliceerd naar de daaropvolgende fasen, en wijzigingen in een werkruimte activeren de implementatie in een releasepijplijn. U kunt de pijplijn configureren om ervoor te zorgen dat wijzigingen efficiënt worden getest en geïmplementeerd in omgevingen.

Fabric ondersteunt verschillende CI/CD-werkstromen die zijn afgestemd op algemene scenario's. Zie CI/CD-werkstroomopties in Fabric voor meer informatie.

Items uit de werkruimte worden opgeslagen in de bijbehorende Git-opslagplaats als Infrastructure as Code (IaC). Codewijzigingen in de opslagplaats kunnen de implementatie in pijplijnen activeren. Met deze methode kunt u codewijzigingen automatisch laten repliceren in fasen voor test- en productiereleasedoeleinden.

Verificatiemethoden voor gegevensbronnen

Wanneer u uw API voor GraphQL maakt, kiest u hoe clients uw gegevensbronnen verifiëren en openen. Deze keuze heeft aanzienlijke gevolgen voor implementatiepipelines en autobinding-gedrag. Inzicht in deze verificatiemethoden is essentieel voor het plannen van uw CI/CD-werkstroom. Zie Het implementatieproces begrijpen voor meer informatie over automatisch verbinden en het implementatieproces.

Er zijn twee connectiviteitsopties beschikbaar bij het verbinden van gegevensbronnen met uw API voor GraphQL: eenmalige aanmelding (SSO) en opgeslagen referenties.

Eenmalige aanmelding (SSO)

Met Single Sign-On (SSO) gebruiken API-cliënten hun eigen referenties voor toegang tot gegevensbronnen. De geverifieerde API-gebruiker moet machtigingen hebben voor zowel de API als de onderliggende gegevensbron.

SSO gebruiken wanneer:

• Fabric-gegevensbronnen beschikbaar maken (lakehouses, magazijnen, SQL-analyse-eindpunten)
• U wilt dat gebruikers toegang hebben tot gegevens op basis van hun afzonderlijke machtigingen
• U hebt beveiliging op rijniveau of ander beleid voor gegevenstoegang nodig om per gebruiker toe te passen

Machtigingsvereisten:

• API-gebruikers hebben uitvoeringsmachtigingen nodig voor de GraphQL-API (Query's en Mutaties uitvoeren)
• API-gebruikers hebben lees- of schrijfmachtigingen nodig voor de gegevensbron
• U kunt ook gebruikers toevoegen als werkruimteleden met de rol Inzender , waarbij zowel de API als de gegevensbron zich bevinden

Gedrag voor automatisch koppelen in implementatiepijplijnen: Wanneer u een API implementeert met behulp van eenmalige aanmelding vanuit de bronwerkruimte (bijvoorbeeld Dev) naar de doelwerkruimte (bijvoorbeeld Testen):

• De gegevensbron en GraphQL-API worden beide geïmplementeerd in de doelwerkruimte
• De API in de doelwerkruimte wordt automatisch gekoppeld aan de kopie van de lokale gegevensbron in de doelwerkruimte
• Elke omgeving (Dev, Test, Production) maakt gebruik van een eigen gegevensbroninstantie.

Opgeslagen referenties

Met opgeslagen referenties wordt één gedeelde referentie geverifieerd tussen de API en gegevensbronnen. API-gebruikers hebben alleen toegang nodig tot de API zelf, niet tot de onderliggende gegevensbronnen.

Opgeslagen referenties gebruiken wanneer:

• Azure-gegevensbronnen beschikbaar maken (Azure SQL Database, externe databases)
• U wilt vereenvoudigd machtigingsbeheer (gebruikers hebben alleen API-toegang nodig)
• Alle API-gebruikers moeten toegang krijgen tot dezelfde gegevens met dezelfde machtigingen
• U hebt consistente referenties nodig voor alle API-aanvragen

Machtigingsvereisten:

• API-gebruikers hebben alleen uitvoeringsmachtigingen nodig voor de GraphQL-API (Query's en Mutaties uitvoeren)
• De opgeslagen referentie zelf moet over de juiste machtigingen voor de gegevensbron beschikken
• Ontwikkelaars die de API implementeren, moeten toegang hebben tot de opgeslagen referentie

Gedrag voor automatisch koppelen in implementatiepijplijnen: Wanneer u een API implementeert met behulp van opgeslagen referenties van de bronwerkruimte (Dev) naar de doelwerkruimte (test):

• De gegevensbron wordt geïmplementeerd in de doelwerkruimte
• De API in de doelwerkruimte blijft verbonden met de gegevensbron in de bronwerkruimte (Dev)
• Automatisch verbinden doet zich niet voor : de geïmplementeerde API blijft de opgeslagen referentie gebruiken die verwijst naar de oorspronkelijke gegevensbron
• U moet verbindingen handmatig opnieuw configureren of nieuwe opgeslagen referenties maken in elke doelomgeving

Verbindingen tussen werkruimten

Als uw API in de bronwerkruimte (Dev) verbinding maakt met een gegevensbron in een andere werkruimte, blijft de geïmplementeerde API in de doelwerkruimte (Test) verbonden met die externe gegevensbron , ongeacht de verificatiemethode. Automatisch verbinden werkt alleen wanneer zowel de API als de gegevensbron zich in dezelfde bronwerkruimte bevinden.

In het volgende diagram ziet u de volgende implementatiescenario's:

Zie Verbinding maken met een gegevensbron voor meer informatie over het instellen van deze verificatiemethoden bij het maken van uw API.

API voor GraphQL Git-integratie

Fabric-API voor GraphQL biedt ondersteuning voor Git-integratie, zodat u uw GraphQL-API's kunt beheren als code in uw versiebeheersysteem. Deze integratie biedt versiegeschiedenis, samenwerking via vertakkingen en pull-aanvragen, de mogelijkheid om wijzigingen te herstellen en een volledig audittrail van API-wijzigingen. Door uw GraphQL API-configuratie als Infrastructure as Code (IaC) te behandelen, kunt u best practices voor softwareontwikkeling toepassen op uw gegevenstoegangslaag.

Git-integratie is essentieel voor:

• Versiebeheer: alle wijzigingen in uw GraphQL-schema, gegevensbronverbindingen en relaties in de loop van de tijd bijhouden
• Samenwerking: Samenwerken met teamleden met branches, pull requests en codebeoordelingen
• Mogelijkheid voor terugdraaien: terugkeren naar eerdere API-configuraties wanneer er problemen optreden
• Omgevingspromotie: Git gebruiken als de bron van waarheid voor het implementeren van API's in omgevingen

Uw werkruimte verbinden met Git

Git-integratie inschakelen voor uw GraphQL-API's:

1. Werkruimte-instellingen openen voor de werkruimte met uw API voor GraphQL
2. De Git-verbinding met uw opslagplaats configureren (Azure DevOps, GitHub of andere Git-provider)
3. Nadat u verbinding hebt gemaakt, worden alle werkruimte-items, inclusief API's voor GraphQL, weergegeven in het configuratiescherm Bron

Zie Aan de slag met Git-integratie voor gedetailleerde installatie-instructies.

Uw GraphQL-API's doorvoeren en synchroniseren

Nadat u verbinding hebt gemaakt met Git, kunt u uw API voor GraphQL-configuraties doorvoeren naar de opslagplaats. Elke doorvoering maakt een momentopname van uw API-definitie, waaronder:

• GraphQL-schema-definities
• Gegevensbronverbindingen en verificatie-instellingen
• Relatieconfiguraties
• Definities voor query's en mutaties

Zodra ze zijn doorgevoerd, komen uw GraphQL-API's in uw Git-repository te staan met een gestructureerde maphiërarchie. Vanaf dit punt kunt u gebruikmaken van standaard Git-werkstromen, zoals het maken van pull-aanvragen, het beheren van vertakkingen en het samenwerken met uw team via codebeoordelingen. Zie Vertakkingen beheren voor meer informatie over het werken met vertakkingen.

GraphQL API-weergave in Git

Elke API voor GraphQL-item wordt opgeslagen in Git met een goed gedefinieerde mapstructuur die alle aspecten van uw API-configuratie vertegenwoordigt:

De API-definitiebestanden bevatten alle metagegevens die nodig zijn om uw GraphQL-API opnieuw te maken in een Fabric-werkruimte. Dit omvat schemadefinities, toewijzingen van gegevensbronnen en configuratie-instellingen. Wanneer u van Git terug naar een Fabric-werkruimte synchroniseert, gebruikt het systeem deze definitiebestanden om uw API precies te herstellen zoals bij het doorvoeren:

Werken met API-definitiebestanden:

De GraphQL API-definitie-indeling volgt de IaC-standaarden (Infrastructure as Code) van Fabric. U kunt deze bestanden rechtstreeks in uw Git-opslagplaats bekijken en bewerken, hoewel de meeste wijzigingen moeten worden aangebracht via de Fabric-portal om de geldigheid van het schema te garanderen. De definitiebestanden zijn met name handig voor:

• Codebeoordelingen: teamleden kunnen API-wijzigingen in pull-aanvragen controleren
• Documentatie: De bestanden fungeren als documentatie van uw API-structuur
• Automatisering: CI/CD-pijplijnen kunnen deze bestanden lezen om inzicht te hebben in API-configuraties
• Herstel na noodgevallen: volledige API-definities blijven behouden in versiebeheer

Zie de Fabric control plane API-documentatie voor gedetailleerde informatie over de GraphQL API-definitie-indeling, syntaxis en voorbeelden:

• GraphQL API-definitie
• Een GraphQLApi maken met een voorbeeld van een openbare definitie

API voor GraphQL in implementatiepijplijn

Met implementatiepijplijnen kunt u uw API promoveren voor GraphQL-configuraties in verschillende omgevingen (meestal ontwikkelen, testen en productie). Wanneer u een API voor GraphQL implementeert via een pijplijn, worden alleen de API-metagegevens gekopieerd, waaronder schemadefinities, gegevensbronverbindingen en relatieconfiguraties. De werkelijke gegevens blijven in de verbonden gegevensbronnen en worden niet gekopieerd tijdens de implementatie.

Belangrijke overwegingen bij de implementatie:

Voordat u implementeert, moet u begrijpen hoe verificatiemethoden en werkruimte-organisatie van invloed zijn op uw implementatie:

• API's met behulp van single Sign-On (SSO) kunnen automatisch worden gekoppeld aan lokale gegevensbronnen in de doelwerkruimte (wanneer de gegevensbron ook is geïmplementeerd vanuit dezelfde bronwerkruimte)
• API's die opgeslagen referenties gebruiken, worden niet automatisch gekoppeld en blijven verbonden met de gegevensbron van de bronwerkruimte
• Gegevensbronnen tussen werkruimten worden nooit automatisch gekoppeld, ongeacht de verificatiemethode

Zie Inzicht in het implementatieproces voor een uitgebreid begrip van het implementatieproces.

Uw API implementeren voor GraphQL

Uw API voor GraphQL implementeren met behulp van implementatiepijplijnen:

1. Maak een nieuwe implementatiepijplijn of open een bestaande pijplijn. Zie Aan de slag met implementatiepijplijnen voor gedetailleerde instructies.

2. Wijs werkruimten toe aan de pijplijnfasen (ontwikkeling, test, productie) op basis van uw implementatiestrategie. Elke fase moet een toegewezen werkruimte hebben.

3. Items tussen fasen controleren en vergelijken. De pijplijn laat zien welke API's voor GraphQL zijn gewijzigd, aangegeven door itemaantallen in de gemarkeerde gebieden. Deze vergelijking helpt u inzicht te krijgen in wat er door de implementatie wordt beïnvloed.

   

4. Selecteer de API's voor GraphQL en eventuele gerelateerde items (zoals verbonden gegevensbronnen) die u wilt implementeren. Selecteer vervolgens Implementeren om ze naar de volgende fase te verplaatsen.

   

5. Bekijk het bevestigingsdialoogvenster voor de implementatie, waarin alle items worden weergegeven die moeten worden geïmplementeerd. Selecteer Implementeren om door te gaan.

   

Huidige beperkingen

Bij het implementeren van API's voor GraphQL via implementatiepijplijnen heeft automatische binding de volgende beperkingen:

• Onderliggende items: Autobinding werkt niet wanneer de API verbinding maakt met een SQL Analytics-eindpunt dat een onderliggend element is van een bovenliggende gegevensbron (zoals een Lakehouse). De geïmplementeerde API blijft verbonden met het eindpunt van de bronwerkruimte.

• Opgeslagen referenties: API's die gebruikmaken van de verificatiemethode Opgeslagen referenties bieden geen ondersteuning voor automatisch verbinden. De API blijft na de implementatie verbonden met de gegevensbron van de bronwerkruimte.

Zie Verificatiemethoden voor gegevensbronnen voor gedetailleerde informatie over verificatiemethoden en hun gedrag voor automatisch verbinden.

Verwante inhoud

• Wat is Microsoft Fabric API voor GraphQL?
• Gegevens maken en toevoegen aan een API voor GraphQL
• Git-integratie
• Implementatiepijplijnen
• CI/CD-werkstroomopties in Fabric