kiota

Proyek

Kiota adalah alat baris perintah untuk menghasilkan klien API untuk memanggil API apa pun yang dijelaskan OpenAPI yang Anda minati. Tujuannya adalah untuk menghilangkan kebutuhan untuk bergantung pada API SDK yang berbeda untuk setiap API yang perlu Anda panggil. Klien Kiota API memberikan pengalaman yang sangat diketik dengan semua fitur yang Anda harapkan dari API SDK berkualitas tinggi, tetapi tanpa harus mempelajari perpustakaan baru untuk setiap API HTTP.

Pustaka ini dibangun di atas pustaka Microsoft.OpenAPI.NET untuk memastikan dukungan komprehensif untuk API yang menggunakan deskripsi OpenAPI. Salah satu tujuan proyek ini adalah untuk memberikan dukungan pembuat kode terbaik untuk fitur OpenAPI dan Skema JSON. Dokumentasi konseptual menjelaskan cara kerja kiota dan konsep tingkat tinggi, readme ini mendokumentasikan cara memulai Kiota.

Memulai

Menghasilkan SDK

1. Instal alat dan dependensi yang diperlukan. (lihat tabel Bahasa yang Didukung di kolom Alat & dependensi yang diperlukan )
2. Dapatkan Kiota menggunakan salah satu opsi yang tersedia.
3. Hasilkan klien API Anda, periksa referensi Parameter untuk berbagai opsi.
4. Mulai panggil API Anda menggunakan Klien API Anda yang fasih.

Bahasa yang didukung

Tabel berikut memberikan ikhtisar bahasa yang didukung oleh Kiota dan kemajuan penerapan berbagai komponen.

Bahasa	Generasi	Abstraksi	Serialisasi	Otentikasi	HTTP	Alat & dependensi yang diperlukan
CLI		(lihat CSharp) +	(lihat CSharp)	(lihat CSharp)	(lihat CSharp)	link
CSharp	✔	✔	BENTUK, JSON, MULTIPART, TEKS	Anonim, Kunci API, Azure	✔	link
Anak panah	▶		BENTUK, ▶ JSON, ▶ MULTIPART, TEKS	Anonim, Kunci API
Pergi	✔	✔	BENTUK, JSON, MULTIPART, TEKS	Anonim, Kunci API, Azure	✔	link
Jawa	✔	✔	BENTUK, JSON, MULTIPART, TEKS	Anonim, Kunci API, Azure	✔	link
PHP	✔	✔	JSON, BENTUK, MULTIPART, TEKS	Anonim, ✔️ Liga PHP	✔	link
ular piton	✔	✔	BENTUK, JSON, MULTIPART, TEKS	Anonim, Azure	✔	link
Rubi			BENTUK, JSON, MULTIPART, TEKS	Anonim, OAuth2
Cepat			BENTUK, JSON, BENTUK, TEKS	Anonim, Azure
Ketik/JavaScript			BENTUK, JSON, MULTIPART, TEKS	Anonim, Kunci API, Azure, SPFx		link

Legenda: ✔ -> stabil, -> dalam pratinjau, -> belum dimulai, ▶ -> sedang berlangsung.

Referensi parameter

Parameter didokumentasikan di sini.

Men-debug

Pastikan Anda menginstal prasyaratnya terlebih dahulu. Jika Anda menggunakan Visual Studio Code sebagai IDE, file launch.json sudah berisi konfigurasi untuk menjalankan Kiota. Secara default, konfigurasi ini akan menggunakan openApiDocs/v1.0/Mail.yml di bawah repositori PowerShell sebagai OpenAPI untuk menghasilkan SDK. Secara default, konfigurasi ini akan menampilkan file yang dihasilkan dalam folder graphdotnetv4|graphjavav4|graphtypescriptv4 yang terletak di folder induk tempat repositori ini dikloning.

Memilih bahasa yang Anda inginkan untuk menghasilkan klien API di tab Visual Studio Debug dan menekan F5 akan secara otomatis membangun, memulai, dan melampirkan proses debugging ke Kiota.

Sampel

Anda dapat menemukan sampel klien yang dihasilkan dengan Kiota di repositori sampel Kiota.

Contoh aplikasi yang memanggil beberapa API dapat ditemukan di repo KiotaApp

Berkontribusi

Proyek ini menyambut baik kontribusi dan saran. Sebagian besar kontribusi mengharuskan Anda menyetujui Perjanjian Lisensi Kontributor (CLA) yang menyatakan bahwa Anda berhak, dan memang benar, memberi kami hak untuk menggunakan kontribusi Anda. Untuk detailnya, kunjungi https://cla.opensource.microsoft.com.

Saat Anda mengirimkan permintaan tarik, bot CLA akan secara otomatis menentukan apakah Anda perlu memberikan CLA dan menghiasi PR dengan tepat (misalnya, pemeriksaan status, komentar). Cukup ikuti instruksi yang diberikan oleh bot. Anda hanya perlu melakukan ini sekali di seluruh repo menggunakan CLA kami.

Proyek ini telah mengadopsi Kode Etik Sumber Terbuka Microsoft. Untuk informasi lebih lanjut lihat FAQ Pedoman Perilaku atau hubungi [email protected] jika ada pertanyaan atau komentar tambahan.

Merek Dagang

Proyek ini mungkin berisi merek dagang atau logo untuk proyek, produk, atau layanan. Penggunaan resmi atas merek dagang atau logo Microsoft tunduk dan harus mengikuti Pedoman Merek Dagang & Merek Microsoft. Penggunaan merek dagang atau logo Microsoft dalam versi modifikasi proyek ini tidak boleh menimbulkan kebingungan atau menyiratkan sponsor Microsoft. Segala penggunaan merek dagang atau logo pihak ketiga tunduk pada kebijakan pihak ketiga tersebut.