Megosztás a következőn keresztül:

Egyéni összekötő létrehozása OpenAPI-definíció alapján

  • Cikk

Megjegyzés

Ez a témakör egy oktatóanyag-sorozat része, amely az egyéni összekötők az Azure Logic Apps, a Microsoft Power Automate és a Microsoft Power Apps szolgáltatásokban való létrehozását és használatát tárgyalja. A folyamat megértéséhez mindenképpen olvassa el az egyéni összekötők áttekintése című témakört.

Egyéni összekötő létrehozásához le kell írnia az API-t, amelyhez csatlakozni kíván, hogy az összekötő megértse az API műveleteit és adatstruktúráját. Ebben a témakör létrehoz egy egyéni összekötőt egy OpenAPI definíció használatával, amely leírja a Cognitive Services Text Analytics Sentiment API-t (ebben a sorozatban a példánk).

Az API-k leírásának másik módja: Egyéni összekötő létrehozása nulláról.

Előfeltételek

  • A OpenAPI példa API-t leíró definíció . Egyéni összekötő létrehozásakor a OpenAPI definíciónak 1 MB-nál kisebbnek kell lennie. A OpenAPI definíciónak 2.0 (korábbi nevén Swagger) formátumúnak kell lennie OpenAPI .

    Ha több biztonsági definíció is van, az egyéni összekötő kiválasztja a legfelső biztonsági definíciót. Az egyéni összekötők létrehozása nem támogatja az ügyfél hitelesítő adatait (például az alkalmazást és a jelszót) az OAuth biztonsági definíciójában.

  • API-kulcs a Cognitive Services Text Analytics API-hoz.

  • Az alábbi előfizetések egyike:

  • Logic Apps használata esetén először hozzon létre egy egyéni Azure Logic Apps-összekötőt.

A definíció importálása OpenAPI

Most már készen áll a OpenAPI letöltött definícióval való munkára. Az összes szükséges információ szerepel a definícióban, és áttekintheti és frissítheti ezeket az adatokat az egyéni összekötő varázsló lépéseit követve.

Először importálja a OpenAPI definícióját Logic Apps vagy for Power Automate és Power Apps.

Megjegyzés

A OpenAPI definíciónak 2.0 (korábbi nevén Swagger) formátumúnak kell lennie OpenAPI . OpenAPI A 3.0-s OpenAPI formátumú definíciók nem támogatottak.

A Logic Apps definíciójának importálása OpenAPI

  1. Lépjen az Azure Portalra, és nyissa meg az Azure Logic Apps egyéni összekötőjének létrehozását ismertető szakaszban korábban létrehozott Logic Apps-összekötőt.

  2. Az összekötő menüjében válassza a Logic Apps Összekötő, majd a Szerkesztés lehetőséget.

    Szerkessze Logic Apps összekötőt.

  3. Az Általános alatt válassza a Fájl feltöltése lehetőséget OpenAPI , majd lépjen a létrehozott definícióra OpenAPI .

    Fájl feltöltése OpenAPI .

Megjegyzés

Ez az oktatóanyag egy REST API-ra összpontosít, de használható SOAP API is a Logic Apps-szolgáltatással.

A és definíciójának importálása OpenAPI Power Automate Power Apps

  1. Jelentkezzen be a Power Apps vagy a Power Automate szolgáltatásba.

  2. A bal oldali panelen válassza az Egyéni adatösszekötők > lehetőséget.

    Válassza az egyéni összekötő lehetőséget.

  3. Válassza az Új egyéni összekötő, majd a Fájl importálása lehetőséget OpenAPI .

    Fájl importálása OpenAPI .

  4. Adja meg az egyéni összekötő nevét, lépjen a letöltött vagy létrehozott definícióra, majd válassza a OpenAPI Folytatás lehetőséget.

    Töltsön fel egy gyűjteményt.

    Paraméter Érték
    Egyéni összekötő címe SentimentDemo

Általános adatok áttekintése

A leírás innentől a Power Automate felhasználói felületére vonatkozik, azonban a lépések nagyjából megegyeznek mindhárom technológia esetében. Az esetleges különbségekre rámutatunk. A témakör ezen részében többnyire áttekintjük a felhasználói felületet, és megmutatjuk, hogy az értékek hogyan felelnek meg a OpenAPI fájl szakaszainak.

  1. A varázsló tetején győződjön meg arról, hogy a név SentimentDemo értékre van állítva , majd válassza az Összekötő létrehozása lehetőséget .

  2. Az Általános lapon tekintse át a OpenAPI definícióból importált információkat, beleértve az API-gazdagépet és az API alap URL-címét. Az összekötő az API-gazda és az alapvető URL-cím segítségével állapítja meg, hogyan hívja meg az API-t.

    Egyéni összekötő Általános oldala.

    Megjegyzés

    További információ helyszíni az API-khoz való csatlakozásról: Csatlakozás helyszíni API-khoz az adatátjáró használatával.

    A definíció következő szakasza OpenAPI a felhasználói felület ezen lapjára vonatkozó információkat tartalmazza:

      "info": {
    "version": "1.0.0",
    "title": "SentimentDemo",
    "description": "Uses the Cognitive Services Text Analytics Sentiment API to determine whether text is positive or negative"
  },
  "host": "westus.api.cognitive.microsoft.com",
  "basePath": "/",
  "schemes": [
    "https"
  ]

Hitelesítési típus áttekintése

Az egyéni összekötőkben többféle hitelesítési lehetőség is elérhető. A Cognitive Services API-k API-kulcsos hitelesítést használnak, így ez van megadva a OpenAPI definícióban.

A Biztonság lapon tekintse át az API-kulcs hitelesítési információit.

API-kulcsparaméterek.

A címke akkor jelenik meg, amikor valaki először létesít kapcsolatot az egyéni összekötővel; kiválaszthatja a Szerkesztés lehetőséget, és módosíthatja ezt az értéket. A paraméter nevének és helyének meg kell egyeznie az API által várt értékkel, ebben az esetben Ocp-Apim-Subscription-Key és fejléc.

A definíció következő szakasza OpenAPI a felhasználói felület ezen lapjára vonatkozó információkat tartalmazza:

  "securityDefinitions": {
    "api_key": {
      "type": "apiKey",
      "in": "header",
      "name": "Ocp-Apim-Subscription-Key"
    }
  }

Az összekötő definíciójának áttekintése

Az egyéni összekötő varázsló Definíció lapja számos lehetőséget kínál az összekötő működésének meghatározására, valamint annak meghatározására, hogy hogyan legyen elérhető az Logic Apps, folyamatokban és alkalmazásokban. Ismertetjük a felhasználói felületet, és bemutatunk néhány lehetőséget ebben a szakaszban, de arra is javasoljuk, hogy saját maga is fedezze fel. További információ az objektumok nulláról való definiálásáról ebben a felhasználói felületen: Az összekötő definíciójának létrehozása.

  1. A következő területen jelennek meg az összekötőhöz definiált műveletek, eseményindítók (a Logic Apps és a Power Automate esetében) és hivatkozások. Ebben az esetben megjelenik a DetectSentiment OpenAPI definícióból származó művelet. Ebben az összekötőben nincsenek eseményindítók, az egyéni összekötőkben lévő eseményindítókról azonban a következő témakörben talál információkat: Webhookok használata az Azure Logic Apps és a Power Automate esetében.

    Definíciós oldal - műveletek és triggerek.

  2. Az Általános terület a kiválasztott művelettel vagy eseményindítóval kapcsolatos információkat jeleníti meg. Itt szerkesztheti is az információkat, beleértve műveletek és paraméterek Láthatóság tulajdonságát a logikai alkalmazásokban és folyamatokban:

    • nincs: normál esetben megjelenik a logikai alkalmazásban vagy folyamatban

    • fejlett: Egy további menü alatt elrejtve található

    • belső: A felhasználók elől rejtve van

    • fontos: mindig elsőként jelenik meg a felhasználó számára

      Definíciós oldal - általános.

  3. A Kérés terület a definícióban OpenAPI szereplő HTTP-kérésen alapuló információkat jeleníti meg. Ebben az esetben láthatja, hogy a HTTP-művelet POST, az URL-cím pedig /text/analytics/v2.0/sentiment (az API <https://westus.api.cognitive.microsoft.com//text/analytics/v2.0/sentiment> teljes URL-címe). Hamarosan közelebbről megvizsgáljuk a body paramétert.

    Definíciós oldal - kérés.

    A definíció következő szakasza OpenAPI a felhasználói felület Általános és Kérés területeire vonatkozó információkat tartalmaz:

    "paths": {
  "/text/analytics/v2.0/sentiment": {
    "post": {
      "summary": "Returns a numeric score representing the sentiment detected",
      "description": "The API returns a numeric score between 0 and 1. Scores close to 1 indicate positive sentiment, while scores close to 0 indicate negative sentiment.",
      "operationId": "DetectSentiment"

  4. A válasz terület a definícióban szereplő HTTP-válasz OpenAPI alapján jeleníti meg az információkat. Ebben az esetben az egyetlen definiált válasz a 200 (sikeres válasz), de további válaszokat is megadhat.

    Definíciós oldal - válasz.

    A meghatározás következő szakasza OpenAPI a válasz kapcsolatos néhány információt tartalmaz:

    "score": {
 "type": "number",
 "format": "float",
 "description": "score",
 "x-ms-summary": "score"
},
"id": {
 "type": "string",
 "description": "id",
 "x-ms-summary": "id"
}

    Ez a szakasz a csatlakozó által visszaadott két értéket jeleníti meg: id és score. Tartalmazza az adattípusokat és a mezőt x-ms-summary, amely egy OpenAPI kiterjesztés. További információ erről és más bővítményekről: Egyéni összekötő OpenAPI definíciójának kiterjesztése.

  5. Az Érvényesítés területen jelennek meg az API-definícióban észlelt problémák. Az összekötő mentése előtt mindenképp tekintse át ezt a területet.

    Definíciós oldal - érvényesítés.

A definíció frissítése

A OpenAPI letöltött definíció jó alapszintű példa, de előfordulhat, hogy olyan definíciókkal dolgozik, amelyek sok frissítést igényelnek, hogy az összekötő barátságosabb legyen, ha valaki logikai alkalmazásban, folyamatban vagy alkalmazásban használja. Megmutatjuk, hogyan módosíthatja a definíciót.

  1. A Kérés területen válassza a törzset , majd válassza a Szerkesztés lehetőséget.

    Kérelem törzsének szerkesztése.

  2. A Paraméter területen most az API által várt három paraméter látható: ID, Language és Text. Válassza az Azonosító, majd a Szerkesztés lehetőséget.

    Szerkessze a kérelem törzsének azonosítóját.

  3. A Sématulajdonság területen frissítse a paraméter leírását, majd válassza a Vissza lehetőséget.

    Sématulajdonság szerkesztése.

    Paraméter Érték
    Description Minden beküldött dokumentum numerikus azonosítója

  4. A Paraméter területen válassza a Vissza lehetőséget, hogy visszatérjen a fő definíciós oldalra.

  5. A varázsló jobb felső sarkában válassza az Összekötő frissítése lehetőséget.

Töltse le a frissített OpenAPI fájlt

Egyéni összekötőt létrehozhat fájlból OpenAPI vagy nulláról (és Power Automate Power Apps). Az összekötő létrehozásának módjától függetlenül letöltheti a OpenAPI szolgáltatás által belsőleg használt definíciót.

  • A Logic Appsben az egyéni összekötőből töltheti le.

    Töltse le OpenAPI a Logic Apps definícióját.

  • A Power Automate vagy Power Apps szolgáltatásban töltse le az egyéni összekötők listájából.

    Definíció letöltése OpenAPI a következőhöz Power Automate: .

Az összekötő tesztelése

Most, hogy létrehozta az összekötőt, tesztelje, hogy megfelelően működik-e. A tesztelés jelenleg csak a Power Automate és a Power Apps szolgáltatásokban érhető el.

Fontos

API-kulcs használata esetén javasoljuk, hogy ne tesztelje az összekötőt közvetlenül a létrehozása után. Eltarthat néhány percig, amíg a csatlakozó készen áll az API-hoz való kapcsolódásra.

  1. A Teszt lapon válassza az Új kapcsolat lehetőséget.

    Új kapcsolat.

  2. Adja meg az API-kulcsot a Text Analytics API-ból, majd válassza a Kapcsolat létrehozása lehetőséget.

    Kapcsolat létrehozása.

  3. Térjen vissza a Teszt lapra, és tegye a következők egyikét:

    • A Power Automate megoldásban a rendszer a Teszt lapra lépteti vissza. Válassza a frissítés ikont annak ellenőrzéséhez, hogy a kapcsolati adatok frissültek-e.

      Kapcsolat frissítése.

    • A Power Apps szolgáltatásban a rendszer az aktuális környezetben elérhető kapcsolatok listájára lépteti vissza. A jobb felső sarokban válassza a fogaskerék ikont, majd válassza az Egyéni összekötők lehetőséget. Válassza ki a létrehozott összekötőt, majd térjen vissza a Teszt lapra.

      Fogaskerék ikon a szolgáltatásban.

  4. A Teszt lapon adjon meg egy értéket a szövegmezőhöz (a többi mező a korábban beállított alapértelmezett értékeket használja), majd válassza a Művelet tesztelése lehetőséget.

    Teszt művelet.

  5. Az összekötő meghívja az API-t, és Ön áttekintheti a választ, amely tartalmazza a hangulati pontszámot is.

    Csatlakozó válasz.

További lépések

Most, hogy létrehozott egy egyéni összekötőt, és definiálta annak működését, használatba is veheti az összekötőt.

Az összekötőt a szervezeten belül is megoszthatja, vagy hitelesíttetheti, hogy a szervezeten kívüli személyek is használhassák.

Visszajelzés küldése

Nagyra értékeljük az összekötőplatform problémáival kapcsolatos visszajelzéseket és az új funkciókkal kapcsolatos ötleteket. Ha visszajelzést szeretne küldeni, lépjen a Problémák küldése vagy segítség kérése az összekötőkkel kapcsolatban részre, és válassza ki a visszajelzés típusát.