kiota

Projekt

Kiota ist ein Befehlszeilentool zum Generieren eines API-Clients zum Aufrufen jeder von OpenAPI beschriebenen API, an der Sie interessiert sind. Das Ziel besteht darin, die Notwendigkeit zu beseitigen, für jede API, die Sie aufrufen müssen, eine Abhängigkeit von einem anderen API-SDK einzugehen. Kiota-API-Clients bieten ein stark typisiertes Erlebnis mit allen Funktionen, die Sie von einem hochwertigen API-SDK erwarten, ohne jedoch für jede HTTP-API eine neue Bibliothek erlernen zu müssen.

Diese Bibliothek baut auf der Microsoft.OpenAPI.NET-Bibliothek auf, um umfassende Unterstützung für APIs zu gewährleisten, die OpenAPI-Beschreibungen verwenden. Eines der Ziele des Projekts besteht darin, die bestmögliche Codegenerator-Unterstützung für OpenAPI- und JSON-Schema-Funktionen bereitzustellen. Die konzeptionelle Dokumentation beschreibt die Funktionsweise von Kiota und die übergeordneten Konzepte. In dieser Readme-Datei wird dokumentiert, wie Sie mit Kiota beginnen.

Erste Schritte

Generieren von SDKs

1. Installieren Sie die erforderlichen Tools und Abhängigkeiten. (siehe Tabelle „Unterstützte Sprachen“ in der Spalte „Erforderliche Tools und Abhängigkeiten“ )
2. Holen Sie sich Kiota mit einer der verfügbaren Optionen.
3. Generieren Sie Ihren API-Client und sehen Sie sich die Parameterreferenz für die verschiedenen Optionen an.
4. Beginnen Sie mit dem Aufruf Ihrer API mit Ihrem Fluent-API-Client.

Unterstützte Sprachen

Die folgende Tabelle gibt einen Überblick über die von Kiota unterstützten Sprachen und den Fortschritt bei der Implementierung der verschiedenen Komponenten.

Sprache	Generation	Abstraktionen	Serialisierung	Authentifizierung	HTTP	Erforderliche Tools und Abhängigkeiten
CLI		(siehe CSharp) +	(siehe CSharp)	(siehe CSharp)	(siehe CSharp)	Link
CSharp	✔	✔	FORM, JSON, MULTIPART, TEXT	Anonym, API-Schlüssel, Azure	✔	Link
Pfeil	▶		FORM, ▶ JSON, ▶ MULTIPART, TEXT	Anonym, API-Schlüssel
Gehen	✔	✔	FORM, JSON, MULTIPART, TEXT	Anonym, API-Schlüssel, Azure	✔	Link
Java	✔	✔	FORM, JSON, MULTIPART, TEXT	Anonym, API-Schlüssel, Azure	✔	Link
PHP	✔	✔	JSON, FORM, MULTIPART, TEXT	Anonym, ✔️ PHP League	✔	Link
Python	✔	✔	FORM, JSON, MULTIPART, TEXT	Anonym, Azure	✔	Link
Rubin			FORM, JSON, MULTIPART, TEXT	Anonym, OAuth2
Schnell			FORMULAR, JSON, FORMULAR, TEXT	Anonym, Azure
TypeScript/JavaScript			FORM, JSON, MULTIPART, TEXT	Anonym, API-Schlüssel, Azure, SPFx		Link

Legende: ✔ -> stabil, -> in der Vorschau, -> nicht gestartet, ▶ -> in Bearbeitung.

Parameterreferenz

Parameter werden hier dokumentiert.

Debuggen

Stellen Sie sicher, dass Sie zuerst die Voraussetzungen installieren. Wenn Sie Visual Studio Code als Ihre IDE verwenden, enthält die Datei launch.json bereits die Konfiguration zum Ausführen von Kiota. Standardmäßig verwendet diese Konfiguration openApiDocs/v1.0/Mail.yml im PowerShell-Repository als OpenAPI zum Generieren eines SDK für. Standardmäßig gibt diese Konfiguration die generierten Dateien in einem Ordner „graphdotnetv4|graphjavav4|graphtypescriptv4“ aus, der sich im übergeordneten Ordner befindet, in den dieses Repository geklont wird.

Wenn Sie auf der Registerkarte „Debuggen“ von Visual Studio die Sprache auswählen, für die Sie einen API-Client generieren möchten, und F5 drücken, wird der Debugging-Prozess automatisch erstellt, gestartet und an Kiota angehängt.

Proben

Beispiele von Clients, die mit Kiota generiert wurden, finden Sie im Kiota-Beispiel-Repository.

Ein Beispiel für eine Anwendung, die mehrere APIs aufruft, finden Sie im KiotaApp-Repository

Mitwirken

Dieses Projekt freut sich über Beiträge und Vorschläge. Für die meisten Beiträge müssen Sie einem Contributor License Agreement (CLA) zustimmen, in dem Sie erklären, dass Sie das Recht haben, uns die Rechte zur Nutzung Ihres Beitrags zu gewähren, und dies auch tatsächlich tun. Weitere Informationen finden Sie unter https://cla.opensource.microsoft.com.

Wenn Sie eine Pull-Anfrage einreichen, ermittelt ein CLA-Bot automatisch, ob Sie eine CLA bereitstellen müssen, und schmückt die PR entsprechend (z. B. Statusprüfung, Kommentar). Folgen Sie einfach den Anweisungen des Bots. Sie müssen dies nur einmal für alle Repos tun, die unsere CLA verwenden.

Dieses Projekt hat den Microsoft Open Source Verhaltenskodex übernommen. Weitere Informationen finden Sie in den FAQ zum Verhaltenskodex oder wenden Sie sich bei weiteren Fragen oder Kommentaren an [email protected].

Marken

Dieses Projekt kann Marken oder Logos für Projekte, Produkte oder Dienstleistungen enthalten. Die autorisierte Nutzung von Microsoft-Marken oder -Logos unterliegt den Marken- und Markenrichtlinien von Microsoft und muss diesen entsprechen. Die Verwendung von Microsoft-Marken oder -Logos in geänderten Versionen dieses Projekts darf keine Verwirrung stiften oder eine Sponsorschaft durch Microsoft implizieren. Jegliche Nutzung von Marken oder Logos Dritter unterliegt den Richtlinien dieser Drittanbieter.