Az Azure Digital Twins Swagger referenciadokumentációja
Fontos
Megjelent az Azure Digital Twins szolgáltatás új verziója. Az új szolgáltatás bővített képességeinek fényében az eredeti Azure Digital Twins szolgáltatást (amelyet a jelen dokumentációs készlet ismertet) kivonták.
Az új szolgáltatás dokumentációjának megtekintéséhez tekintse meg az aktív Azure Digital Twins-dokumentációt.
Minden kiépített Azure Digital Twins-példány saját, automatikusan létrehozott Swagger-referenciadokumentációt tartalmaz.
A Swagger vagy OpenAPI interaktív és nyelvfüggetlen referenciaerőforrássá egyesíti az összetett API-információkat. A Swagger kritikus referenciaanyagot biztosít arról, hogy mely JSON-hasznos adatok, HTTP-metódusok és adott végpontok használhatók az API-kon végzett műveletek végrehajtásához.
Swagger-összefoglalás
A Swagger interaktív összegzést nyújt az API-ról, amely a következőket tartalmazza:
- API- és objektummodell-információk.
- REST API-végpontok, amelyek a szükséges hasznos adatokat, fejléceket, paramétereket, környezeti útvonalakat és HTTP-metódusokat adják meg.
- API-funkciók tesztelése.
- Példa a HTTP-válaszok ellenőrzésére és megerősítésére használt válaszinformációkra.
- Hibakód-információk.
A Swagger kényelmes eszköz az Azure Digital Twins Management API-khoz intézett fejlesztési és tesztelési hívásokhoz.
Tipp
A Swagger sneak előzetes verziója az API-funkciókészlet bemutatására szolgál. A docs.westcentralus.azuresmartspaces.net/management/swagger üzemelteti.
A saját generált Management API Swagger-dokumentációját a következő címen érheti el:
https://YOUR_INSTANCE_NAME.YOUR_LOCATION.azuresmartspaces.net/management/swagger
| Name | Csere erre |
|---|---|
| YOUR_INSTANCE_NAME | Az Azure Digital Twins-példány neve |
| YOUR_LOCATION | A példány által üzemeltetett kiszolgálórégió |
Referenciaanyag
Az automatikusan létrehozott Swagger-referenciaanyag gyors áttekintést nyújt a fontos fogalmakról, az elérhető Felügyeleti API-végpontokról, valamint az egyes objektummodellek leírásáról a fejlesztés és tesztelés elősegítése érdekében.
Az API rövid összefoglalása.
A felügyeleti API-objektummodellek is fel vannak sorolva.
Az egyes felsorolt objektummodellek kiválasztásával részletesebben összegezheti a fő attribútumokat.
A létrehozott Swagger-objektummodellek kényelmesen olvashatók az összes elérhető Azure Digital Twins-objektum és API olvasásához. A fejlesztők akkor használhatják ezt az erőforrást, ha megoldásokat készítenek az Azure Digital Twinsre.
Végpont összegzése
A Swagger átfogó áttekintést nyújt a felügyeleti API-kat alkotó összes végpontról.
Minden felsorolt végpont tartalmazza a szükséges kérésadatokat is, például a következőket:
- Kötelező paraméterek.
- Kötelező paraméter-adattípusok.
- HTTP-metódus az erőforrás eléréséhez.
Válassza ki az egyes erőforrásokat a további tartalmak megjelenítéséhez, hogy részletesebb áttekintést kapjon.
Végpontok tesztelése a Swagger használatával
A Swagger által biztosított egyik hatékony funkció az API-végpontok tesztelésének lehetősége közvetlenül a dokumentációs felhasználói felületen keresztül.
Miután kiválasztott egy adott végpontot, megjelenik a Kipróbálás gomb.
Bontsa ki ezt a szakaszt az egyes kötelező és opcionális paraméterek beviteli mezőinek megjelenítéséhez. Adja meg a megfelelő értékeket, és válassza a Végrehajtás lehetőséget.
A teszt végrehajtása után ellenőrizheti a válaszadatokat.
Swagger-válaszadatok
A felsorolt végpontok választörzs-adatokat is tartalmaznak a fejlesztés és a tesztek ellenőrzéséhez. Ilyen például az állapotkódok és a sikeres HTTP-kérések JSON-fájlja.
A példák hibakódokat is tartalmaznak a sikertelen tesztek hibakereséséhez vagy javításához.
Swagger OAuth 2.0-hitelesítés
Megjegyzés
- Az Azure Digital Twins-erőforrást létrehozó egyszerű felhasználó egy helyrendszergazdai szerepkör-hozzárendeléssel fog rendelkezni, és további szerepkör-hozzárendeléseket hozhat létre más felhasználók számára. Ezek a felhasználók és szerepköreik jogosultak az API-k meghívására.
Azure Active Directory-alkalmazás létrehozásához és konfigurálásához kövesse a rövid útmutató lépéseit. Másik lehetőségként újra felhasználhat egy meglévő alkalmazásregisztrációt.
Adja hozzá a következő átirányítási URI-t az Azure Active Directory-alkalmazásregisztrációhoz:
https://YOUR_SWAGGER_URL/ui/oauth2-redirect-htmlName Csere erre Példa YOUR_SWAGGER_URL A felügyeleti REST API dokumentációjának URL-címe megtalálható a portálon https://yourDigitalTwinsName.yourLocation.azuresmartspaces.net/management/swaggerJelölje be az Implicit hozzáférési>jogkivonatok jelölőnégyzetet az OAuth 2.0 implicit engedélyezési folyamat használatának engedélyezéséhez. Válassza a Konfigurálás, majd a Mentés lehetőséget.
Másolja ki az Azure Active Directory-alkalmazás ügyfél-azonosítóját .
Az Azure Active Directory-regisztráció befejezése után:
Válassza az Engedélyezés gombot a swagger oldalán.
Illessze be az alkalmazásazonosítót a client_id mezőbe.
Ezután a rendszer átirányítja a következő sikerességi modálisra.
Az OAuth 2.0 által védett kérelmek interaktív teszteléséről a hivatalos dokumentációban olvashat bővebben.
Következő lépések
Az Azure Digital Twins objektummodelljeiről és a térbeliintelligencia-gráfról az Azure Digital Twins-objektummodellek ismertetése című témakörben olvashat bővebben.
Ha meg szeretné tudni, hogyan hitelesítheti magát a felügyeleti API-val, olvassa el a Hitelesítés API-kkal című témakört.