kiota
v1.21.0
Kiota est un outil de ligne de commande permettant de générer un client API pour appeler toute API décrite par OpenAPI qui vous intéresse. L'objectif est d'éliminer le besoin de dépendre d'un SDK API différent pour chaque API que vous devez appeler. Les clients API Kiota offrent une expérience fortement typée avec toutes les fonctionnalités que vous attendez d'un SDK API de haute qualité, mais sans avoir à apprendre une nouvelle bibliothèque pour chaque API HTTP.
Cette bibliothèque s'appuie sur la bibliothèque Microsoft.OpenAPI.NET pour garantir une prise en charge complète des API qui utilisent les descriptions OpenAPI. L'un des objectifs du projet est de fournir la meilleure prise en charge possible du générateur de code pour les fonctionnalités OpenAPI et JSON Schema. La documentation conceptuelle décrit le fonctionnement de Kiota et les concepts de haut niveau. Ce fichier Lisez-moi explique comment démarrer avec Kiota.
Le tableau suivant donne un aperçu des langues prises en charge par Kiota et des progrès dans la mise en œuvre des différents composants.
| Langue | Génération | Abstractions | Sérialisation | Authentification | HTTP | Outils requis et dépendances |
|---|---|---|---|---|---|---|
| CLI | (voir CSharp) + | (voir CSharp) | (voir CSharp) | (voir CSharp) | lien | |
| CSharp | ✔ | ✔ | FORMULAIRE, JSON, MULTIPART, TEXTE | Anonyme, clé API, Azure | ✔ | lien |
| Dard | ▶ | FORMULAIRE, ▶ JSON, ▶ MULTIPART, TEXTE | Anonyme, clé API | |||
| Aller | ✔ | ✔ | FORMULAIRE, JSON, MULTIPART, TEXTE | Anonyme, clé API, Azure | ✔ | lien |
| Java | ✔ | ✔ | FORMULAIRE, JSON, MULTIPART, TEXTE | Anonyme, clé API, Azure | ✔ | lien |
| PHP | ✔ | ✔ | JSON, FORMULAIRE, MULTIPART, TEXTE | Anonyme, ✔️ Ligue PHP | ✔ | lien |
| Python | ✔ | ✔ | FORMULAIRE, JSON, MULTIPART, TEXTE | Anonyme, Azur | ✔ | lien |
| Rubis | FORMULAIRE, JSON, MULTIPART, TEXTE | Anonyme, OAuth2 | ||||
| Rapide | FORMULAIRE, JSON, FORMULAIRE, TEXTE | Anonyme, Azur | ||||
| TypeScript/JavaScript | FORMULAIRE, JSON, MULTIPART, TEXTE | Anonyme, clé API, Azure, SPFx | lien |
Légende : ✔ -> stable, -> en avant-première, -> non démarré, ▶ -> en cours.
Les paramètres sont documentés ici.
Assurez-vous d'abord d'installer les prérequis. Si vous utilisez Visual Studio Code comme IDE, le fichier launch.json contient déjà la configuration pour exécuter Kiota. Par défaut, cette configuration utilisera openApiDocs/v1.0/Mail.yml sous le référentiel PowerShell comme OpenAPI pour lequel générer un SDK. Par défaut, cette configuration affichera les fichiers générés dans un dossier graphdotnetv4|graphjavav4|graphtypescriptv4 situé dans le dossier parent dans lequel ce référentiel est cloné.
En sélectionnant la langue pour laquelle vous souhaitez générer un client API dans l'onglet Débogage de Visual Studio et en appuyant sur F5 , vous créerez, démarrerez et attacherez automatiquement le processus de débogage à Kiota.
Vous pouvez trouver des exemples de clients générés avec Kiota dans le référentiel d'exemples Kiota.
Un exemple d'application appelant plusieurs API peut être trouvé dans le dépôt KiotaApp.
Ce projet accueille les contributions et suggestions. La plupart des contributions nécessitent que vous acceptiez un contrat de licence de contributeur (CLA) déclarant que vous avez le droit de nous accorder, et que vous nous accordez effectivement, le droit d'utiliser votre contribution. Pour plus de détails, visitez https://cla.opensource.microsoft.com.
Lorsque vous soumettez une pull request, un robot CLA déterminera automatiquement si vous devez fournir un CLA et décorera le PR de manière appropriée (par exemple, vérification du statut, commentaire). Suivez simplement les instructions fournies par le bot. Vous n’aurez besoin de le faire qu’une seule fois pour tous les dépôts utilisant notre CLA.
Ce projet a adopté le code de conduite Microsoft Open Source. Pour plus d’informations, consultez la FAQ sur le code de conduite ou contactez [email protected] pour toute question ou commentaire supplémentaire.
Ce projet peut contenir des marques ou des logos pour des projets, des produits ou des services. L'utilisation autorisée des marques ou logos Microsoft est soumise et doit respecter les directives relatives aux marques et aux marques de Microsoft. L'utilisation des marques ou logos Microsoft dans les versions modifiées de ce projet ne doit pas prêter à confusion ni impliquer le parrainage de Microsoft. Toute utilisation de marques ou de logos tiers est soumise aux politiques de ces tiers.
