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


OData API importálása

A KÖVETKEZŐRE VONATKOZIK: Minden API-kezelési szint

Ez a cikk bemutatja, hogyan importálhat egy OData-kompatibilis szolgáltatást API-ként az API Managementben.

Ebben a cikkben az alábbiakkal ismerkedhet meg:

  • OData-metaadat-leírás importálása az Azure Portal használatával
  • Az OData-séma kezelése a portálon
  • Az OData API védelme

Előfeltételek

  • API Management-példány. Ha még nincs ilyenje, végezze el az alábbi rövid útmutatót: Azure API Management-példány létrehozása.

  • OData v2 vagy v4 néven közzétett szolgáltatás.

Nyissa meg az API Management-példányát

  1. Az Azure portálonkeresse meg és válassza ki a API Management szolgáltatásokat:

    képernyőkép, amely az API Management-szolgáltatásokat jeleníti meg a keresési eredmények között.

  2. Az API Management-szolgáltatások lapon válassza ki az API Management-példányt:

    Képernyőkép, amely egy API Management-példányt jelenít meg az API Management szolgáltatások lapján.

OData-metaadatok importálása

  1. A bal oldali menüben válassza az API-kat>, majd kattintson az + API hozzáadása gombra.

  2. Az Definíció alapján létrehozás alatt válassza az OData elemet:

    Képernyőkép egy API létrehozásáról egy OData-leírásból a portálon.

  3. Adja meg az API-beállításokat. A beállítások később frissíthetők az API Beállítások lapján.

    1. Az OData-specifikációban adjon meg egy OData-metaadat-végpont URL-címét. Ez az érték általában a szolgáltatásgyökér URL-címe, amelyhez /$metadatahozzá van fűzve. Másik lehetőségként válasszon egy importálandó helyi OData XML-fájlt.

    2. Adjon meg további beállításokat az API konfigurálásához. Ezeket a beállításokat az „Importálja és publikálja az első API-t” oktatóanyag ismerteti.

  4. Válassza a Létrehozás lehetőséget.

    Az API hozzá lesz adva az API-k listájához. Az OData metaadatok leírásában közzétett entitáskészletek és függvények az API Entitáskészletek és függvények lapján jelennek meg.

    OData-entitáskészleteket és -függvényeket bemutató képernyőkép.

Az OData-séma frissítése

A portál egyik szerkesztőjéhez hozzáférhet az API OData-sémájának megtekintéséhez. Ha az API megváltozik, a sémát egy fájlból vagy egy OData-szolgáltatásvégpontból is frissítheti az API Managementben.

  1. A portálon keresse meg az API Management-példányt.

  2. A bal oldali menüben válassza az API-kat, majd az OData API-t.

  3. Az Entitáskészletek és függvények lapon jelölje ki az entitáskészlet vagy függvény melletti három pontot (...), majd válassza a Szerkesztés lehetőséget.

    Képernyőkép a Szerkesztés parancs helyéről.

  4. Tekintse át a sémát. Ha frissíteni szeretné, válassza a Frissítés fájlból vagy a Séma frissítése a végpontról lehetőséget.

    Az OData API sémaszerkesztőjének képernyőképe.

Az OData API tesztelése

  1. A bal oldali menüben válassza az API-kat, majd az OData API-t.

  2. Az Entitáskészletek és függvények lapon jelölje ki az entitáskészlet vagy függvény melletti három pontot (...), majd válassza a Tesztelés lehetőséget.

    Képernyőkép a Tesztelés parancsról.

  3. A tesztkonzolon adja meg a teszt sablonparamétereit, lekérdezési paramétereit és fejléceit, majd válassza a Tesztelés lehetőséget. Az API-k portálon való teszteléséről további információt az új API tesztelése a portálon című témakörben talál.

Az OData API védelme

Az OData API védelme meglévő hitelesítési és engedélyezési szabályzatok és OData érvényesítési szabályzatok alkalmazásával az OData API-kérések által végrehajtott támadások elleni védelem érdekében.

Tipp

A portálon konfigurálja az OData API szabályzatait az API-szabályzatok lapon.

Egyéb API-k hozzáfűzése

Az API-kat különböző szolgáltatások által közzétett API-kból állíthatja össze, többek között a következőket:

  • OpenAPI-specifikáció
  • A SOAP API (programozási alkalmazásinterfész)
  • A GraphQL programozási interfész (API)
  • Az Azure App Service-ben üzemeltetett webalkalmazás
  • Azure Functions
  • Azure Logic Apps
  • Azure Service Fabric

Feljegyzés

Api importálásakor a műveletek hozzá lesznek fűzve az aktuális API-hoz.

API hozzáfűzése egy meglévő API-hoz:

  1. Nyissa meg az Azure API Management-példányt az Azure Portalon:

    Képernyőkép az API Management-szolgáltatások oldalról.

  2. Válassza az API-k lehetőséget az Áttekintés lapon, vagy válassza az API-k>API-k opciót a bal oldali menüben.

    Képernyőkép, amelyen az API-k kiválasztása látható az Áttekintés lapon.

  3. Jelölje ki a három pontot (...) azon API mellett, amelyhez hozzá szeretne fűzni egy másik API-t.

  4. Válassza a Importálás lehetőséget a legördülő menüből:

    Képernyőkép az Importálás parancsról.

  5. Válasszon egy szolgáltatást, amelyből importálni fogja az API-t.