Kiota เป็นเครื่องมือบรรทัดคำสั่งสำหรับสร้างไคลเอ็นต์ API เพื่อเรียกใช้ API ที่อธิบายไว้ใน OpenAPI ใดๆ ที่คุณสนใจ เป้าหมายคือเพื่อขจัดความจำเป็นในการพึ่งพา API SDK ที่แตกต่างกันสำหรับ API แต่ละตัวที่คุณต้องการเรียกใช้ ไคลเอนต์ Kiota API มอบประสบการณ์การพิมพ์ที่ชัดเจนด้วยฟีเจอร์ทั้งหมดที่คุณคาดหวังจาก API SDK คุณภาพสูง แต่ไม่จำเป็นต้องเรียนรู้ไลบรารีใหม่สำหรับ HTTP API ทุกอัน
ไลบรารีนี้สร้างขึ้นจากไลบรารี Microsoft.OpenAPI.NET เพื่อให้มั่นใจถึงการสนับสนุนที่ครอบคลุมสำหรับ API ที่ใช้คำอธิบาย OpenAPI เป้าหมายประการหนึ่งของโปรเจ็กต์คือการให้การสนับสนุนตัวสร้างโค้ดที่ดีที่สุดสำหรับฟีเจอร์ OpenAPI และ JSON Schema เอกสารเชิงแนวคิดจะอธิบายวิธีการทำงานของ kiota และแนวคิดระดับสูง เอกสาร readme นี้จัดทำเอกสารวิธีเริ่มต้นใช้งาน Kiota
ตารางต่อไปนี้แสดงภาพรวมของภาษาที่ Kiota รองรับ และความคืบหน้าในการใช้งานส่วนประกอบต่างๆ
ภาษา | รุ่น | นามธรรม | การทำให้เป็นอนุกรม | การรับรองความถูกต้อง | HTTP | เครื่องมือและการพึ่งพาที่จำเป็น |
---|---|---|---|---|---|---|
คลีไอ | (ดูซีชาร์ป) + | (ดูซีชาร์ป) | (ดูซีชาร์ป) | (ดูซีชาร์ป) | ลิงค์ | |
ซีชาร์ป | แบบฟอร์ม, JSON, หลายส่วน, ข้อความ | ไม่ระบุชื่อ, คีย์ API, Azure | ลิงค์ | |||
โผ | แบบฟอร์ม, ▶ JSON, ▶ หลายส่วน, ข้อความ | ไม่ระบุชื่อ, คีย์ API | ||||
ไป | แบบฟอร์ม, JSON, หลายส่วน, ข้อความ | ไม่ระบุชื่อ, คีย์ API, Azure | ลิงค์ | |||
ชวา | แบบฟอร์ม, JSON, หลายส่วน, ข้อความ | ไม่ระบุชื่อ, คีย์ API, Azure | ลิงค์ | |||
PHP | JSON, แบบฟอร์ม, หลายส่วน, ข้อความ | ไม่ระบุชื่อ ✔️ ลีก PHP | ลิงค์ | |||
หลาม | แบบฟอร์ม, JSON, หลายส่วน, ข้อความ | ผู้ไม่ประสงค์ออกนาม, อาซูร์ | ลิงค์ | |||
ทับทิม | แบบฟอร์ม, JSON, หลายส่วน, ข้อความ | ไม่ระบุชื่อ OAuth2 | ||||
สวิฟท์ | แบบฟอร์ม, JSON, แบบฟอร์ม, ข้อความ | ผู้ไม่ประสงค์ออกนาม, อาซูร์ | ||||
ประเภทสคริปต์/จาวาสคริปต์ | แบบฟอร์ม, JSON, หลายส่วน, ข้อความ | ไม่ระบุชื่อ, คีย์ API, Azure, SPFx | ลิงค์ |
คำอธิบาย: ✔ -> เสถียร -> อยู่ในการแสดงตัวอย่าง -> ยังไม่เริ่ม ▶ -> อยู่ระหว่างดำเนินการ
พารามิเตอร์ได้รับการบันทึกไว้ที่นี่
ตรวจสอบให้แน่ใจว่าคุณติดตั้งข้อกำหนดเบื้องต้นก่อน If you are using Visual Studio Code as your IDE, the launch.json file already contains the configuration to run Kiota. ตามค่าเริ่มต้น การกำหนดค่านี้จะใช้ openApiDocs/v1.0/Mail.yml
ภายใต้พื้นที่เก็บข้อมูล PowerShell เป็น OpenAPI เพื่อสร้าง SDK สำหรับ ตามค่าเริ่มต้น การกำหนดค่านี้จะส่งออกไฟล์ที่สร้างขึ้นในโฟลเดอร์ graphdotnetv4|graphjavav4|graphtypescriptv4 ที่อยู่ในโฟลเดอร์หลักที่เก็บข้อมูลนี้ถูกโคลนมา
การเลือกภาษาที่คุณต้องการสร้างไคลเอ็นต์ API ในแท็บ Visual Studio Debug แล้วกด F5 จะสร้าง เริ่มต้น และแนบกระบวนการดีบักกับ Kiota โดยอัตโนมัติ
คุณสามารถค้นหาตัวอย่างไคลเอ็นต์ที่สร้างด้วย Kiota ได้ในที่เก็บตัวอย่าง Kiota
ตัวอย่างของแอปพลิเคชันที่เรียก API หลายตัวสามารถพบได้ใน repo kiotaapp
โครงการนี้ยินดีรับการสนับสนุนและข้อเสนอแนะ การบริจาคส่วนใหญ่กำหนดให้คุณยอมรับข้อตกลงใบอนุญาตผู้ร่วมให้ข้อมูล (CLA) โดยประกาศว่าคุณมีสิทธิ์ที่จะให้สิทธิ์แก่เราในการใช้การบริจาคของคุณจริงๆ สำหรับรายละเอียด โปรดไปที่ https://cla.opensource.microsoft.com
เมื่อคุณส่งคำขอดึง บอท CLA จะกำหนดโดยอัตโนมัติว่าคุณจำเป็นต้องจัดเตรียม CLA และตกแต่ง PR อย่างเหมาะสมหรือไม่ (เช่น การตรวจสอบสถานะ ความคิดเห็น) เพียงทำตามคำแนะนำที่ได้รับจากบอท คุณจะต้องทำสิ่งนี้เพียงครั้งเดียวกับ repos ทั้งหมดโดยใช้ CLA ของเรา
โครงการนี้ได้นำหลักจรรยาบรรณของ Microsoft Open Source มาใช้ สำหรับข้อมูลเพิ่มเติม โปรดดูคำถามที่พบบ่อยเกี่ยวกับจรรยาบรรณหรือติดต่อ [email protected] หากมีคำถามหรือความคิดเห็นเพิ่มเติม
โครงการนี้อาจมีเครื่องหมายการค้าหรือโลโก้สำหรับโครงการ ผลิตภัณฑ์ หรือบริการ การใช้เครื่องหมายการค้าหรือโลโก้ของ Microsoft โดยได้รับอนุญาตจะอยู่ภายใต้และต้องปฏิบัติตามแนวทางเครื่องหมายการค้าและแบรนด์ของ Microsoft การใช้เครื่องหมายการค้าหรือโลโก้ของ Microsoft ในเวอร์ชันแก้ไขของโครงการนี้จะต้องไม่ทำให้เกิดความสับสนหรือบ่งบอกถึงการสนับสนุนของ Microsoft การใช้เครื่องหมายการค้าหรือโลโก้ของบุคคลที่สามจะต้องเป็นไปตามนโยบายของบุคคลที่สามเหล่านั้น