Kiota 是一個命令列工具,用於產生 API 用戶端來呼叫您感興趣的任何 OpenAPI 描述的 API。 Kiota API 用戶端提供強型別體驗以及您期望從高品質 API SDK 獲得的所有功能,但無需為每個 HTTP API 學習新的程式庫。
該程式庫建構在 Microsoft.OpenAPI.NET 程式庫之上,以確保對使用 OpenAPI 描述的 API 的全面支援。該專案的目標之一是為 OpenAPI 和 JSON Schema 功能提供最佳的程式碼產生器支援。概念文件描述了 kiota 的工作原理和高級概念,本自述文件記錄如何開始使用 Kiota。
下表概述了 Kiota 支援的語言以及不同組件的實施進度。
語言 | 世代 | 抽象 | 序列化 | 驗證 | HTTP協定 | 所需工具和相依性 |
---|---|---|---|---|---|---|
命令列介面 | (參見 CSharp)+ | (參見 CSharp) | (參見 CSharp) | (參見 CSharp) | 關聯 | |
夏普 | ✔ | ✔ | 表單、JSON、多部分、文本 | 匿名、API 金鑰、Azure | ✔ | 關聯 |
鏢 | ▶ | 表單、▶ JSON、▶ 多部分、文字 | 匿名、API 金鑰 | |||
去 | ✔ | ✔ | 表單、JSON、多部分、文本 | 匿名、API 金鑰、Azure | ✔ | 關聯 |
爪哇 | ✔ | ✔ | 表單、JSON、多部分、文本 | 匿名、API 金鑰、Azure | ✔ | 關聯 |
PHP | ✔ | ✔ | JSON、表單、多部分、文本 | 匿名,✔️ PHP 聯盟 | ✔ | 關聯 |
Python | ✔ | ✔ | 表單、JSON、多部分、文本 | 匿名,蔚藍 | ✔ | 關聯 |
紅寶石 | 表單、JSON、多部分、文本 | 匿名、OAuth2 | ||||
迅速 | 表單、JSON、表單、文本 | 匿名,蔚藍 | ||||
TypeScript/JavaScript | 表單、JSON、多部分、文本 | 匿名、API 金鑰、Azure、SPFx | 關聯 |
圖例:✔ -> 穩定,-> 預覽中,-> 未開始,▶ -> 正在進行。
參數記錄在此處。
確保首先安裝先決條件。如果您使用 Visual Studio Code 作為 IDE,則launch.json檔案已包含執行 Kiota 的設定。預設情況下,此配置將使用 PowerShell 儲存庫下的openApiDocs/v1.0/Mail.yml
作為 OpenAPI 來產生 SDK。預設情況下,此配置將在 graphdotnetv4|graphjavav4|graphtypescriptv4 資料夾中輸出產生的文件,該資料夾位於此儲存庫克隆的父資料夾中。
在 Visual Studio 偵錯標籤中選擇要為其產生 API 用戶端的語言,然後按F5將自動建置、啟動偵錯進程並將其附加到 Kiota。
您可以在 Kiota 範例儲存庫中找到使用 Kiota 產生的客戶端範例。
呼叫多個 API 的應用程式範例可以在 KiotaApp 儲存庫中找到
該項目歡迎貢獻和建議。大多數貢獻都要求您同意貢獻者授權協議 (CLA),聲明您有權並且實際上授予我們使用您的貢獻的權利。有關詳細信息,請訪問 https://cla.opensource.microsoft.com。
當您提交拉取請求時,CLA 機器人將自動確定您是否需要提供 CLA 並適當地修飾 PR(例如,狀態檢查、評論)。只需按照機器人提供的說明進行操作即可。您只需使用我們的 CLA 在所有儲存庫中執行一次此操作。
該專案採用了微軟開源行為準則。有關詳細信息,請參閱行為準則常見問題解答或聯繫 [email protected] 提出任何其他問題或意見。
該項目可能包含項目、產品或服務的商標或標誌。 Microsoft 商標或標誌的授權使用須遵守且必須遵循 Microsoft 的商標和品牌指南。在此項目的修改版本中使用 Microsoft 商標或標誌不得混淆或暗示 Microsoft 贊助。任何對第三方商標或標誌的使用均須遵守這些第三方的政策。