Azure dijital TWINS Swagger başvuru belgeleriAzure Digital Twins Swagger reference documentation

Sağlanan her Azure dijital TWINS örneği, kendi otomatik olarak oluşturulan Swagger başvuru belgelerini içerir.Each provisioned Azure Digital Twins instance includes its own automatically generated Swagger reference documentation.

Swaggerveya openapı, karmaşık API bilgilerini etkileşimli ve dilden bağımsız bir başvuru kaynağına ayırır.Swagger, or OpenAPI, unites complex API information into an interactive and language-agnostic reference resource. Swagger, bir API 'ye karşı işlem gerçekleştirmek için kullanılacak olan JSON yükleri, HTTP yöntemleri ve belirli uç noktalar hakkında kritik başvuru malzemeleri sağlar.Swagger provides critical reference material about which JSON payloads, HTTP methods, and specific endpoints to use to perform operations against an API.

Swagger ÖzetiSwagger summary

Swagger, API 'nizin etkileşimli bir özetini sağlar ve şunları içerir:Swagger provides an interactive summary of your API, which includes:

  • API ve nesne modeli bilgileri.API and object model information.
  • Gerekli istek yüklerini, üstbilgileri, parametreleri, bağlam yollarını ve HTTP yöntemlerini belirten uç noktalar REST API.REST API endpoints that specify the required request payloads, headers, parameters, context paths, and HTTP methods.
  • API işlevlerini test etme.Testing of API functionalities.
  • HTTP yanıtlarını doğrulamak ve doğrulamak için kullanılan örnek yanıt bilgileri.Example response information used to validate and confirm HTTP responses.
  • Hata kodu bilgileri.Error code information.

Swagger, Azure Digital TWINS yönetim API 'Lerine yapılan geliştirme ve test çağrılarına yardımcı olan kullanışlı bir araçtır.Swagger is a convenient tool to assist with development and testing calls made to the Azure Digital Twins Management APIs.

İpucu

API özelliği kümesini göstermek için Swagger gizli dizi önizlemesi sağlanır.A Swagger sneak preview is provided to demonstrate the API feature set. Docs.westcentralus.azuresmartspaces.net/Management/Swaggeradresinde barındırılır.It's hosted at docs.westcentralus.azuresmartspaces.net/management/swagger.

Üzerinde kendi üretilen yönetim API Swagger belgelerinize erişebilirsiniz:You can access your own generated Management API Swagger documentation at:

https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger
AdName Şununla değiştirReplace with
YOUR_INSTANCE_NAMEYOUR_INSTANCE_NAME Azure dijital TWINS örneğinizin adıThe name of your Azure Digital Twins instance
YOUR_LOCATIONYOUR_LOCATION Örneğiniz üzerinde barındırılıyorsa hangi sunucu bölgeWhich server region your instance is hosted on

Başvuru kaynaklarıReference material

Otomatik olarak oluşturulan Swagger başvuru malzemeleri, önemli kavramlara, kullanılabilir yönetim API uç noktalarına ve geliştirme ve test etmeye yardımcı olmak için her nesne modelinin açıklamasına yönelik hızlı bir genel bakış sağlar.The automatically generated Swagger reference material supplies a quick overview of important concepts, available Management API endpoints, and a description of each object model to assist development and testing.

Kısa bir Özet API 'YI tanımlar.A concise summary describes the API.

Swagger üstSwagger top

Yönetim API 'SI nesne modelleri de listelenir.Management API object models are also listed.

Swagger modellerini Swagger models

Anahtar özniteliklerinin daha ayrıntılı bir özeti için listelenen her nesne modelini seçebilirsiniz.You can select each listed object model for a more detailed summary of key attributes.

Swagger modeliSwagger model

Oluşturulan Swagger nesne modelleri, tüm kullanılabilir Azure dijital TWINS nesnelerini ve API 'lerigörmek için uygundur.The generated Swagger object models are convenient to see all available Azure Digital Twins objects and APIs. Geliştiriciler, Azure dijital TWINS üzerinde çözümler oluştururken bu kaynağı kullanabilir.Developers can use this resource when they build solutions on Azure Digital Twins.

Uç nokta ÖzetiEndpoint summary

Swagger ayrıca yönetim API 'Lerini oluşturan tüm uç noktalara kapsamlı bir genel bakış sağlar.Swagger also provides a thorough overview of all endpoints that compose the Management APIs.

Listelenen her uç nokta, aşağıdakiler gibi gerekli istek bilgilerini de içerir:Each listed endpoint also includes the required request information, such as the:

  • Gerekli parametreler.Required parameters.
  • Gerekli parametre veri türleri.Required parameter data types.
  • Kaynağa erişmek için HTTP yöntemi.HTTP method to access the resource.

Swagger uç noktalarıSwagger endpoints

Daha ayrıntılı bir genel bakış görmek için her bir kaynağı seçin.To see a more detailed overview, select each resource.

Uç noktaları test etmek için Swagger kullanınUse Swagger to test endpoints

Swagger, bir API uç noktasını doğrudan belgeler kullanıcı arabiriminden test edebilmesidir.One of the powerful functionalities Swagger provides is the ability to test an API endpoint directly through the documentation UI.

Belirli bir uç noktayı seçtikten sonra, deneyinseçeneğini görürsünüz.After you select a specific endpoint, you see Try it out.

Swagger TRYSwagger try

Gerekli ve isteğe bağlı her bir parametre için giriş alanlarını getirmek üzere bu bölümü genişletin.Expand that section to bring up input fields for each required and optional parameter. Doğru değerleri girip Yürüt' ü seçin.Enter the correct values, and select Execute.

Swagger çalıştıSwagger tried

Testi yürütmeden sonra, yanıt verilerini doğrulayabilirsiniz.After you execute the test, you can validate the response data.

Swagger yanıt verileriSwagger response data

Listelenen her uç nokta, geliştirme ve testlerinizi doğrulamak için yanıt gövdesi verilerini de içerir.Each listed endpoint also includes response body data to validate your development and tests. Bu örnekler, başarılı HTTP istekleri için görmek istediğiniz durum kodlarını ve JSON 'yi içerir.These examples include the status codes and JSON you want to see for successful HTTP requests.

Swagger yanıtıSwagger response

Örnekler Ayrıca hata ayıklama veya başarısız testleri geliştirmek için hata kodlarını içerir.The examples also include error codes to help debug or improve failing tests.

Swagger OAuth 2,0 yetkilendirmesiSwagger OAuth 2.0 authorization

Not

  • Azure dijital TWINS kaynağını oluşturan kullanıcı sorumlusunun bir alan Yöneticisi rol ataması olacak ve diğer kullanıcılar için ek rol atamaları oluşturabileceksiniz.The user principal that created the Azure Digital Twins resource will have a Space Administrator role assignment and will be able to create additional role assignments for other users. Bu tür kullanıcılar ve rollerinin API 'Leri çağırma yetkisi bulunabilir.Such users and their roles can be authorized to call the APIs.
  1. Bir Azure AD uygulaması oluşturmak ve yapılandırmak için Bu hızlı başlangıçta bulunan adımları izleyin.Follow the steps in this quickstart to create and configure an Azure AD application. Alternatif olarak, var olan bir uygulama kaydını yeniden kullanabilirsiniz.Alternatively, you can reuse an existing app registration.

  2. Aşağıdaki yanıt URL 'sini uygulama kaydına ekleyin:Add the following reply url to the app registration:

    https://YOUR_SWAGGER_URL/ui/oauth2-redirect-html
    
    AdName Şununla değiştirReplace with ÖrnekExample
    YOUR_SWAGGER_URLYOUR_SWAGGER_URL Portalda yönetim REST API belge URL 'SI bulunduYour Management REST API documentation URL found in the portal https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swagger
  3. Azure AD uygulamanızın KIMLIĞINI kopyalayın.Copy the ID of your Azure AD app.

Azure Active Directory kaydını tamamladıktan sonra:After completing the Azure Active Directory registration:

  1. Swagger sayfanızda Yetkilendir düğmesini seçin.Select the Authorize button on your swagger page.

    Swagger Yetkilendir düğmesini seçinSelect the Swagger authorize button

  2. Uygulama KIMLIĞINI client_id alanına yapıştırın.Paste the application ID into the client_id field.

    Swagger client_id alanıSwagger client_id field

  3. Ardından, aşağıdaki başarılı kalıcı öğesine yönlendirilirsiniz.You will then be redirected to the following success modal.

    Swagger yeniden yönlendirme kalıcıSwagger redirect modal

OAuth 2,0 tarafından korunan etkileşimli test istekleri hakkında daha fazla bilgi edinmek için resmi belgelerebakın.To learn more about interactively testing requests protected by OAuth 2.0, see the official documentation.

Sonraki adımlarNext steps