Dokumentasi referensi Azure Digital Twins Swagger

Penting

Versi baru layanan Azure Digital Twins telah dirilis. Mengingat kemampuan layanan baru yang diperluas, layanan Azure Digital Twins asli (dijelaskan dalam kumpulan dokumentasi ini) telah dihentikan.

Untuk melihat dokumentasi layanan baru, kunjungi Dokumentasi Azure Digital Twins aktif.

Setiap instans Azure Digital Twins yang disediakan menyertakan dokumentasi referensi Swagger yang dibuat secara otomatis.

Swagger, atau OpenAPI, menyatukan informasi API kompleks ke dalam sumber daya referensi interaktif dan bahasa-agnostik. Swagger menyediakan materi referensi penting tentang payload JSON, metode HTTP, dan titik akhir tertentu yang akan digunakan untuk melakukan operasi terhadap API.

Ringkasan Swagger

Swagger menyediakan ringkasan interaktif API Anda, yang meliputi:

• API dan informasi model objek.
• Titik akhir REST API yang menentukan payload permintaan, header, parameter, jalur konteks, dan metode HTTP yang diperlukan.
• Pengujian fungsionalitas API.
• Contoh informasi respons yang digunakan untuk memvalidasi dan mengonfirmasi respons HTTP.
• Informasi kode kesalahan.

Swagger adalah alat yang nyaman untuk membantu pengembangan dan pengujian panggilan yang dilakukan ke API Manajemen Azure Digital Twins.

Tip

Pratinjau sneak Swagger disediakan untuk menunjukkan set fitur API. Ini dihosting di docs.westcentralus.azuresmartspaces.net/management/swagger.

Anda dapat mengakses dokumentasi Management API Swagger yang dibuat sendiri di:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger

Nama	Ganti dengan
YOUR_INSTANCE_NAME	Nama instans Azure Digital Twins Anda
YOUR_LOCATION	Wilayah server mana instans Anda dihosting

Materi referensi

Materi referensi Swagger yang dihasilkan secara otomatis memberikan gambaran singkat tentang konsep penting, titik akhir API Manajemen yang tersedia, dan deskripsi setiap model objek untuk membantu pengembangan dan pengujian.

Ringkasan ringkas menjelaskan API.

Model objek API Manajemen juga tercantum.

Anda dapat memilih setiap model objek yang tercantum untuk ringkasan atribut kunci yang lebih rinci.

Model objek Swagger yang dihasilkan nyaman untuk membaca semua objek dan API Azure Digital Twins yang tersedia. Pengembang dapat menggunakan sumber daya ini saat mereka membangun solusi di Azure Digital Twins.

Ringkasan titik akhir

Swagger juga memberikan gambaran menyeluruh tentang semua titik akhir yang menyusun API Manajemen.

Setiap titik akhir yang tercantum juga menyertakan informasi permintaan yang diperlukan, seperti:

• Parameter yang diperlukan.
• Jenis data parameter yang diperlukan.
• Metode HTTP untuk mengakses sumber daya.

Pilih setiap sumber daya untuk menampilkan konten tambahan mereka untuk mendapatkan gambaran umum yang lebih rinci.

Menggunakan Swagger untuk menguji titik akhir

Salah satu fungsi canggih yang disediakan Swagger adalah kemampuan untuk menguji titik akhir API secara langsung melalui UI dokumentasi.

Setelah Anda memilih titik akhir tertentu, tombol Coba akan ditampilkan.

Perluas bagian tersebut untuk memunculkan bidang input untuk setiap parameter yang diperlukan dan opsional. Masukkan nilai yang benar, dan pilih Jalankan.

Setelah menjalankan pengujian, Anda dapat memvalidasi data respons.

Data respons Swagger

Setiap titik akhir yang tercantum juga menyertakan data isi respons untuk memvalidasi pengembangan dan pengujian Anda. Contoh-contoh ini termasuk kode status dan JSON untuk permintaan HTTP yang berhasil.

Contohnya juga mencakup kode kesalahan untuk membantu men-debug atau meningkatkan pengujian yang gagal.

Otorisasi Swagger OAuth 2.0

Catatan

• Prinsipal pengguna yang membuat sumber daya Azure Digital Twins akan memiliki penetapan peran Administrator Ruang dan akan dapat membuat penetapan peran tambahan untuk pengguna lain. Pengguna tersebut dan peran mereka dapat diberi wewenang untuk memanggil API.

1. Ikuti langkah-langkah dalam Mulai Cepat untuk membuat dan mengonfigurasi aplikasi Azure Active Directory. Atau, Anda dapat menggunakan kembali pendaftaran aplikasi yang ada.

2. Tambahkan URI Pengalihan berikut ke pendaftaran aplikasi Azure Active Directory Anda:

   

   https://YOUR_SWAGGER_URL/ui/oauth2-redirect-html
   

   Nama	Ganti dengan	Contoh
   YOUR_SWAGGER_URL	URL dokumentasi REST API Manajemen Anda ditemukan di portal	https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swagger

3. Pilih kotak centang Beritoken Aksesimplisit> untuk mengizinkan alur pemberian implisit OAuth 2.0 digunakan. Pilih Konfigurasikan, lalu Simpan.

4. Salin ID Klien aplikasi Azure Active Directory Anda.

Setelah menyelesaikan pendaftaran Azure Active Directory:

1. Pilih tombol Otorisasi di halaman swagger Anda.

   

2. Tempelkan ID aplikasi ke bidang client_id .

   

3. Anda kemudian akan diarahkan ke modal keberhasilan berikut.

   

Untuk mempelajari selengkapnya tentang permintaan pengujian interaktif yang dilindungi oleh OAuth 2.0, baca dokumentasi resmi.

Langkah berikutnya

• Untuk membaca selengkapnya tentang model objek Azure Digital Twins dan grafik kecerdasan spasial, baca Memahami model objek Azure Digital Twins.

• Untuk mempelajari cara mengautentikasi dengan API Manajemen Anda, baca Mengautentikasi dengan API.