samedi, 20 avril 2024

Travailler avec le générateur d’API de données d’Azure

La méthode basée sur la plate-forme de Microsoft pour l’avancement du cloud lui a en fait permis d’offrir des variantes gérées de nombreux éléments familiers de la pile technologique, en particulier au sein de sa plate-forme de données. En plus de son propre serveur SQL (comme Azure SQL) et de la base de données de l’univers sans SQL, il a en fait géré des versions de bases de données open source familières, composées de PostgreSQL et MySQL.

En utilisant ces bases de données et API familières simplifie la migration des informations des propriétés vers Azure ou le développement de nouvelles applications cloud natives sans courbe d’apprentissage élevée. Dès que vos informations sont enregistrées sur Azure, vous pouvez utiliser des outils et des techniques familiers pour les utiliser à partir de votre code, en particulier si vous travaillez avec.NET et Java qui disposent de nombreux SDK d’informations officiels et non officiels. Mais que se passe-t-il si vous tirez le meilleur parti des nouveaux modèles de développement tels que Jamstack et utilisez des outils tels qu’Azure Fixed Web Apps pour inclure des interfaces Web pilotées par API dans vos applications ?

Bien que vous puissiez utiliser des outils tels qu’Azure Fonctions ou App Service pour construire votre propre couche d’API de données, cela ajoute de l’inefficacité et augmente vos exigences de maintenance et de test. Au lieu de cela, vous pouvez désormais utiliser le propre outil de construction de maisons de l’API d’informations de Microsoft. Il est basique à configurer et offre une base de données de points de terminaison REST ou GraphQL qui peut être rapidement consommée par JavaScript ou tout autre langage compatible REST. C’est peut-être aussi le moyen le plus rapide de commencer à transformer des bases de données hébergées par Azure en applications.

Présentation de l’outil de construction d’accueil de l’API de données

Développé pour fonctionner sur les installations, au edge et dans le cloud, Data API home builder est un outil open source ciblant 5 bases de données différentes : Azure SQL, SQL Server, PostgreSQL, MySQL et Universe DB. Vous pouvez travailler avec vos propres installations avec les propres services gérés de Microsoft, de sorte que vous pouvez développer et exécuter dans votre propre centre de données et migrer le code vers le cloud si nécessaire.

Si vous utilisez le sous-traitant de l’API d’information comme partie de votre propre code, il s’agit d’un outil .NET proposé en tant que plan Nuget. Vous avez besoin de .NET 6 ou 7 pour l’exécuter, et cela fonctionne sur n’importe quel système compatible .NET, composé de Linux. Une fois installé, vous pouvez utiliser son CLI pour développer les points de terminaison appropriés pour vos bases de données, préparés pour une utilisation dans vos applications. Vous pouvez également utiliser une image de conteneur prête à l’emploi à partir du registre d’ordinateurs de conteneurs de Microsoft. Cette méthode fonctionne bien si vous ciblez des environnements de conteneurs périphériques, tels que le nouveau Azure Kubernetes Service (AKS) Edge Essentials, qui vous offre une plate-forme Kubernetes gérée restreinte.

L’installation est rapide et vous pouvez utiliser le outil avec la commande dab à partir de n’importe quelle ligne de commande. L’assistance est assez fondamentale, mais comme il s’agit d’un outil extrêmement ciblé, vous ne devriez pas le trouver difficile à utiliser. Les outils de ligne de commande à usage unique comme celui-ci constituent une partie très importante de la communauté .NET, et il convient de les connaître car ils peuvent économiser beaucoup de travail et de temps.

Structurer les API à la commande ligne

C’est une excellente idée d’être bien informé sur ADO.NET pour utiliser le sous-traitant de l’API d’information. Ce n’est pas surprenant; c’est la méthode standard d’accès aux services d’information dans.NET et, au fond, c’est un outil.NET, même si vous l’utilisez pour développer des applications Web.

Pour établir une connexion, vous devrez devez connaître la structure de votre base de données et les composants que vous souhaitez exposer. Dans le même temps, vous avez également besoin de chaînes de connexion ADO pour pouvoir établir la connexion préliminaire à votre base de données. Pour les ressources Azure, celles-ci peuvent être découvertes dans le portail Azure dans le cadre de vos propriétés résidentielles ou commerciales de ressources. Vous n’avez pas besoin d’enregistrer les informations de connexion en clair ; vous avez le choix d’utiliser des variables d’environnement pour conserver les données en dehors de votre code au moment de l’exécution, vous pouvez donc utiliser des outils comme Azure Secret Vault pour protéger tous les secrets.

Le sous-traitant de l’API de données utilise un fichier de configuration JSON pour conserver les informations de toutes les API que vous créez. Produisez-le en spécifiant le type de base de données, ainsi qu’une chaîne de connexion. Assurez-vous d’utiliser un compte avec les autorisations appropriées pour votre application. Le fichier d’installation indique les types d’API pris en charge, vous pouvez donc activer REST, GraphQL ou les deux. D’autres parties du fichier de configuration définissent le mode, si le script cross-origin est activé et le type d’authentification utilisé pour la connexion. Pendant que l’outil CLI produit et met à jour les données de configuration, vous pouvez les modifier vous-même à l’aide de la documentation hébergée sur GitHub.

Dès que vous avez spécifié une connexion, vous pouvez établir les API pour votre information. À l’aide d’entités de base de données familières, fournissez un nom à l’API et liez-le à une source, comme une table ou une question, et fournissez-lui les consentements liés aux utilisateurs et aux opérations de base de données. Le nom est utilisé pour développer le chemin de l’API pour REST et GraphQL.

Avec une connexion spécifiée et des entités contribuées au fichier de configuration, vous êtes maintenant prêt à construire et à servir l’API. Le sous-traitant de l’API de données est peut-être mieux considéré comme un simple courtier qui prend les connexions REST et GraphQL, les mappe sur des instructions ADO prédéfinies et les exécute sur la source avant de renvoyer les résultats et de les remapper au format approprié. L’API REST prend en charge les verbes typiques qui correspondent aux opérations CRUD standard (développer, lire, mettre à jour, supprimer) ; par exemple, GET récupérera les informations et POST les écrira.

Chaque verbe REST a des spécifications de requête supplémentaires pour vous aider à gérer vos informations. Vous pouvez filtrer les données, les trier et utiliser des instructions select. Malheureusement, même si vous pouvez sélectionner les premiers éléments à afficher, il ne semble pas y avoir de moyen de paginer les données pour le moment. Espérons que cela sera ajouté dans une future version car cela simplifierait la création de matériel Web à partir des informations de l’enquête.

Utilisation de GraphQL avec le constructeur de maisons de l’API de données

Si vous vous préparez à utiliser GraphQL, il vaut la peine d’utiliser un outil tel que Postman pour aider à construire et vérifier les requêtes. GraphQL peut faire bien plus qu’une requête REST standard, mais il peut être difficile de créer des questions à la main. Avoir un outil pour vérifier l’API et tester les requêtes peut faire gagner beaucoup de temps. Pour les requêtes GraphQL plus complexes, vous devrez développer des relations dans votre configuration. Ici, il est utile d’avoir un diagramme d’entité de votre source de données avec des relations définies que vous pouvez expliquer par le type de relation, l’entité cible de la question et la manière dont la relation est conservée dans votre base de données.

Le La procédure de création d’une API est exactement la même pour toutes les bases de données prises en charge, à une différence près pour Universe DB. Comme il dispose actuellement d’une API REST, il n’est pas nécessaire d’en générer une autre. Vous pouvez toujours l’utiliser pour développer une API GraphQL.

Si vous utilisez cette technique avec Azure Static Web Apps, utilisez d’abord le portail Azure pour ajouter votre base de données source à la configuration de votre site Web. Vous devez ensuite importer un fichier d’installation existant du générateur d’accueil de l’API d’informations. Vous pouvez utiliser à la fois le sous-traitant de l’API de base de données et l’interface de ligne de commande Azure Static Web Apps pour créer les fichiers requis. La CLI Static Web Apps développe un fichier stub pour la configuration, que vous pouvez modifier manuellement ou coller dans le contenu d’un fichier de création d’API de base de données.

Être capable d’inclure l’assistance GraphQL à n’importe quelle base de données est nécessaire ; c’est un moyen beaucoup plus efficace d’interroger des données que les API conventionnelles, simplifiant les questions compliquées. En prenant en charge les API REST et GraphQL, le sous-traitant de l’API de données peut faciliter la migration entre les types d’API, vous permettant de continuer à utiliser des requêtes familières tout en apprenant à structurer GraphQL. En prime, bien qu’il s’agisse d’un outil qui fonctionne pour n’importe quel framework d’application, il vaut la peine de l’utiliser avec Azure Fixed Web Apps pour créer des applications Jamstack connectées aux données.

.

Toute l’actualité en temps réel, est sur L’Entrepreneur

LAISSER UN COMMENTAIRE

S'il vous plaît entrez votre commentaire!
S'il vous plaît entrez votre nom ici