Kiota は、OpenAPI で記述された関心のある API を呼び出すための API クライアントを生成するためのコマンド ライン ツールです。目的は、呼び出す必要がある API ごとに異なる API SDK に依存する必要をなくすことです。 Kiota API クライアントは、高品質の API SDK に期待されるすべての機能を備えた厳密に型指定されたエクスペリエンスを提供しますが、HTTP API ごとに新しいライブラリを学習する必要はありません。
このライブラリは Microsoft.OpenAPI.NET ライブラリの上に構築され、OpenAPI 記述を使用する API の包括的なサポートを保証します。プロジェクトの目標の 1 つは、OpenAPI および JSON スキーマ機能に対して可能な限り最高のコード ジェネレーター サポートを提供することです。概念的なドキュメントでは、kiota の仕組みと高レベルの概念が説明されており、この Readme では Kiota の使用を開始する方法が説明されています。
次の表は、Kiota でサポートされている言語の概要と、さまざまなコンポーネントの実装の進捗状況を示しています。
言語 | 世代 | 抽象化 | 連載 | 認証 | HTTP | 必要なツールと依存関係 |
---|---|---|---|---|---|---|
CLI | (CSharp を参照) + | (CSharp を参照) | (CSharp を参照) | (CSharp を参照) | リンク | |
Cシャープ | ✔ | ✔ | フォーム、JSON、マルチパート、テキスト | 匿名、API キー、Azure | ✔ | リンク |
ダーツ | ▶ | フォーム、 ▶ JSON、 ▶ マルチパート、テキスト | 匿名、API キー | |||
行く | ✔ | ✔ | フォーム、JSON、マルチパート、テキスト | 匿名、API キー、Azure | ✔ | リンク |
ジャワ | ✔ | ✔ | フォーム、JSON、マルチパート、テキスト | 匿名、API キー、Azure | ✔ | リンク |
PHP | ✔ | ✔ | JSON、フォーム、マルチパート、テキスト | 匿名、✔️ PHP リーグ | ✔ | リンク |
パイソン | ✔ | ✔ | フォーム、JSON、マルチパート、テキスト | アノニマス、アズール | ✔ | リンク |
ルビー | フォーム、JSON、マルチパート、テキスト | 匿名、OAuth2 | ||||
迅速 | フォーム、JSON、フォーム、テキスト | アノニマス、アズール | ||||
TypeScript/JavaScript | フォーム、JSON、マルチパート、テキスト | 匿名、API キー、Azure、SPFx | リンク |
凡例: ✔ -> 安定、 -> プレビュー中、 -> 未開始、 ▶ -> 進行中。
パラメータはここに記載されています。
最初に前提条件を必ずインストールしてください。 Visual Studio Code を IDE として使用している場合、 launch.jsonファイルには、Kiota を実行するための構成がすでに含まれています。デフォルトでは、この構成は SDK を生成するための OpenAPI として PowerShell リポジトリの下のopenApiDocs/v1.0/Mail.yml
を使用します。デフォルトでは、この構成は、このリポジトリが複製される親フォルダーにあるgraphdotnetv4|graphjavav4|graphtypescriptv4フォルダーに生成されたファイルを出力します。
Visual Studio の [デバッグ] タブで API クライアントを生成する言語を選択し、 F5 キーを押すと、デバッグ プロセスが自動的にビルド、開始され、Kiota にアタッチされます。
Kiota サンプル リポジトリで、Kiota を使用して生成されたクライアントのサンプルを見つけることができます。
複数の API を呼び出すアプリケーションの例は、KiotaApp リポジトリにあります。
このプロジェクトは貢献と提案を歓迎します。ほとんどの投稿では、投稿を使用する権利をお客様が有しており、実際に当社に付与することを宣言する投稿者ライセンス契約 (CLA) に同意する必要があります。詳細については、https://cla.opensource.microsoft.com をご覧ください。
プル リクエストを送信すると、CLA ボットが CLA を提供する必要があるかどうかを自動的に判断し、PR を適切に装飾します (ステータス チェック、コメントなど)。ボットが提供する指示に従ってください。 CLA を使用するすべてのリポジトリでこれを 1 回行うだけで済みます。
このプロジェクトはマイクロソフトのオープンソース行動規範を採用しています。詳細については、行動規範に関する FAQ を参照するか、追加の質問やコメントがあれば [email protected] までお問い合わせください。
このプロジェクトには、プロジェクト、製品、またはサービスの商標またはロゴが含まれている場合があります。 Microsoft の商標またはロゴの許可された使用には、Microsoft の商標およびブランド ガイドラインが適用され、それに従わなければなりません。このプロジェクトの修正バージョンで Microsoft の商標またはロゴを使用することは、混乱を引き起こしたり、Microsoft のスポンサーであることを暗示したりしてはなりません。第三者の商標またはロゴの使用には、それらの第三者のポリシーが適用されます。