Azure Digital Twins Swagger başvuru belgeleri

Önemli

Azure Digital Twins hizmetinin yeni bir sürümü yayınlandı. Yeni hizmetin genişletilmiş özellikleri ışığında özgün Azure Digital Twins hizmeti (bu belge kümesinde açıklanmıştır) kullanımdan kaldırılmıştır.

Yeni hizmetin belgelerini görüntülemek için etkin Azure Digital Twins Belgeleri'ni ziyaret edin.

Sağlanan her Azure Digital Twins örneği kendi otomatik olarak oluşturulan Swagger başvuru belgelerini içerir.

Swagger veya OpenAPI, karmaşık API bilgilerini etkileşimli ve dilden bağımsız bir başvuru kaynağında birleştirir. Swagger, bir API'de işlem gerçekleştirmek için kullanılacak JSON yükleri, HTTP yöntemleri ve belirli uç noktalar hakkında kritik başvuru malzemeleri sağlar.

Swagger özeti

Swagger, API'nizin aşağıdakileri içeren etkileşimli bir özetini sağlar:

• API ve nesne modeli bilgileri.
• Gerekli istek yüklerini, üst bilgileri, parametreleri, bağlam yollarını ve HTTP yöntemlerini belirten REST API uç noktaları.
• API işlevlerini test etme.
• HTTP yanıtlarını doğrulamak ve onaylamak için kullanılan örnek yanıt bilgileri.
• Hata kodu bilgileri.

Swagger, Azure Digital Twins Yönetim API'lerine yapılan geliştirme ve test çağrılarına yardımcı olmak için kullanışlı bir araçtır.

İpucu

API özellik kümesini göstermek için bir Swagger sneak önizlemesi sağlanır. docs.westcentralus.azuresmartspaces.net/management/swagger'da barındırlenmektedir.

Kendi oluşturduğunuz Yönetim API'si Swagger belgelerine şu konumdan erişebilirsiniz:

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

Name	Şununla değiştir
YOUR_INSTANCE_NAME	Azure Digital Twins örneğinizin adı
YOUR_LOCATION	Örneğinizin barındırıldığı sunucu bölgesi

Başvuru malzemesi

Otomatik olarak oluşturulan Swagger başvuru malzemesi, geliştirme ve teste yardımcı olmak için önemli kavramlara, kullanılabilir Yönetim API'si uç noktalarına ve her nesne modelinin açıklamasına hızlı bir genel bakış sağlar.

Kısa bir özet API'yi açıklar.

Yönetim API'si nesne modelleri de listelenir.

Anahtar özniteliklerinin daha ayrıntılı bir özeti için listelenen her nesne modelini seçebilirsiniz.

Oluşturulan Swagger nesne modelleri, kullanılabilir tüm Azure Digital Twins nesnelerini ve API'lerini okumak için uygundur. Geliştiriciler, Azure Digital Twins üzerinde çözüm oluştururken bu kaynağı kullanabilir.

Uç nokta özeti

Swagger ayrıca Yönetim API'lerini oluşturan tüm uç noktalara kapsamlı bir genel bakış sağlar.

Listelenen her uç nokta aşağıdakiler gibi gerekli istek bilgilerini de içerir:

• Gerekli parametreler.
• Gerekli parametre veri türleri.
• Kaynağa erişmek için HTTP yöntemi.

Daha ayrıntılı bir genel bakış elde etmek için her kaynağı seçerek ek içeriklerini görüntüleyin.

Uç noktaları test etmek için Swagger kullanma

Swagger'ın sağladığı güçlü işlevlerden biri, api uç noktasını doğrudan belge kullanıcı arabirimi aracılığıyla test etme özelliğidir.

Belirli bir uç noktayı seçtikten sonra Deneyin düğmesi görüntülenir.

Gerekli ve isteğe bağlı her parametre için giriş alanlarını getirmek için bu bölümü genişletin. Doğru değerleri girin ve Yürüt'e tıklayın.

Testi yürüttkten sonra yanıt verilerini doğrulayabilirsiniz.

Swagger yanıt verileri

Listelenen her uç nokta, geliştirmenizi ve testlerinizi doğrulamak için yanıt gövdesi verilerini de içerir. Bu örnekler, başarılı HTTP istekleri için durum kodlarını ve JSON'ı içerir.

Örnekler, başarısız testlerde hata ayıklamaya veya iyileştirmeye yardımcı olan hata kodlarını da içerir.

Swagger OAuth 2.0 yetkilendirmesi

Not

• Azure Digital Twins kaynağını oluşturan kullanıcı sorumlusu bir Alan Yöneticisi rol atamasına sahip olur ve diğer kullanıcılar için ek rol atamaları oluşturabilir. Bu kullanıcılar ve rolleri API'leri çağırma yetkisine sahip olabilir.

1. Azure Active Directory uygulaması oluşturmak ve yapılandırmak için Hızlı Başlangıç'taki adımları izleyin. Alternatif olarak, mevcut bir uygulama kaydını yeniden kullanabilirsiniz.

2. Azure Active Directory uygulama kaydınıza aşağıdaki Yeniden Yönlendirme URI'sini ekleyin:

   

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

   Name	Şununla değiştir	Örnek
   YOUR_SWAGGER_URL	Portalda bulunan Yönetim REST API belgeleri URL'niz	https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swagger

3. OAuth 2.0 örtük izin akışının kullanılmasına izin vermek için ÖrtükErişim belirteçleri onay kutusunu seçin.> Yapılandır'ı ve ardından Kaydet'i seçin.

4. Azure Active Directory uygulamanızın İstemci Kimliğini kopyalayın.

Azure Active Directory kaydını tamamladıktan sonra:

1. Swagger sayfanızda Yetki ver düğmesini seçin.

   

2. Uygulama kimliğini client_id alanına yapıştırın.

   

3. Ardından aşağıdaki başarı kalıcısına yönlendirilirsiniz.

   

OAuth 2.0 tarafından korunan istekleri etkileşimli olarak test etme hakkında daha fazla bilgi edinmek için resmi belgeleri okuyun.

Sonraki adımlar

• Azure Digital Twins nesne modelleri ve uzamsal zeka grafı hakkında daha fazla bilgi edinmek için Bkz. Azure Digital Twins nesne modellerini anlama.

• Yönetim API'nizle kimlik doğrulaması yapmayı öğrenmek için API'lerle kimlik doğrulama'yı okuyun.