SAP OData-metaadatok importálása API-ként

Minden API-kezelési szintre vonatkozik

Ez a cikk azt ismerteti, hogyan importálhat OData-szolgáltatást (Open Data Protocol) az Azure API Managementbe OData-metaadatok használatával. Az alábbi példa az SAP Gateway Foundationt használja.

Ebből a cikkből megtudhatja, hogyan:

  • OData-metaadatok lekérése az SAP-szolgáltatásból
  • OData-metaadatok importálása az Azure API Managementbe közvetlenül, vagy miután OpenAPI specifikációvá alakítottuk őket
  • API-konfiguráció befejezése
  • Az API tesztelése a Azure portálon

Előfeltételek

  • Hozzon létre egy API Management-példányt.

  • Olyan SAP-rendszer és szolgáltatás, amely OData v2 vagy v4 néven érhető el.

  • Ha az SAP-háttérrendszer önaláírt tanúsítványt használ (teszteléshez), előfordulhat, hogy le kell tiltania az SSL megbízhatósági láncának ellenőrzését. Ehhez konfiguráljon egy háttérrendszert az API Management-példányban:

    1. Az Azure Portal API-k területén válassza a Háttérrendszerek>+ Új háttér létrehozása lehetőséget.
    2. Adjon hozzá egy egyéni URL-címet , amely az SAP háttérszolgáltatásra mutat.
    3. Bontsa ki a Speciális szakaszt, majd törölje a jelet a Tanúsítványlánc érvényesítése és a Tanúsítványnév ellenőrzése jelölőnégyzetből.

    Megjegyzés:

    Éles helyzetekben használjon megfelelő tanúsítványokat a teljes körű SSL-ellenőrzéshez.

    Tipp

    Az API Management teljes funkciótartományához a regisztráció előtt konvertálja az SAP OData API-t OpenAPI-specifikációvá.

OData-metaadatok lekérése az SAP-szolgáltatásból

A metaadatok XML-jének az SAP-szolgáltatásból való lekéréséhez használja az alábbi módszerek egyikét. Ha a metaadat-XML-t OpenAPI-specifikációvá szeretné konvertálni, mentse a fájlt helyileg.

  • Használja az SAP Gateway-ügyfelet (tranzakció /IWFND/GW_CLIENT).
  • Hozzon létre egy közvetlen HTTP-hívást az XML lekéréséhez: http://<OData server URL>:<port>/<path>/$metadata.
  • Szükség esetén használja az SAP Business Accelerator Hubot .

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

  1. Az Azure Portalon keresse meg és válassza ki az 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.

API importálása az API Managementbe

Válassza az alábbi módszerek egyikét az API API Managementbe való importálásához:

  • Konvertálja a metaadat-XML-t OpenAPI-specifikációvá (ajánlott).
  • Importálja a metaadat-XML-t közvetlenül OData API-ként.

OData-metaadatok konvertálása OpenAPI JSON-ra

  1. Használja a Microsoft konvertert amely az OASIS nyílt forráskódú eszközére épül.

    Az alábbi példa az OData v2 XML-t konvertálja a tesztszolgáltatáshoz epm_ref_apps_prod_man_srv:

    oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json

    Megjegyzés:

    Egyetlen XML-fájllal végzett teszteléshez használhatja a webes felületet.

  2. Mentse a openapi-spec.json fájlt helyileg az API Managementbe való importáláshoz.

OpenAPI-specifikáció importálása

  1. Az oldalsáv menüjében, az API-k szakaszban válassza az API-kat.

  2. A Létrehozás definíció alapján válassza az OpenAPI csempét:

    Képernyőkép az OpenAPI csempéről.

  3. Válassza a Fájl kijelölése lehetőséget, majd válassza ki az előző lépésben helyileg mentett openapi-spec.json fájlt.

  4. Adja meg az API-beállításokat. Ezeket az értékeket az API importálásakor vagy később a Beállítások lapon állíthatja be.

  5. Válassza a Create gombot.

Emellett konfigurálnia kell a háttérrendszer hitelesítését is a környezetéhez megfelelő módszer használatával. Példák: Hitelesítés és engedélyezés.

Megjegyzés:

Az API importálási korlátozásairól további információt az API importálási korlátozásairól és ismert problémáiról talál.

Az API tesztelése

  1. Navigáljon az API Management példányához.

  2. Az oldalsáv menüjében válassza az API-k>API-kat.

  3. Az Összes API területen válassza ki az importált API-t.

  4. A tesztkonzol eléréséhez válassza a Teszt fület.

  5. Válasszon ki egy műveletet, adja meg a szükséges értékeket, majd válassza a Küldés lehetőséget.

    Tesztelje például a hívást az GET /$metadata SAP háttérrendszerhez való kapcsolódás ellenőrzéséhez.

  6. Tekintse meg a választ. A hibaelhárításhoz kövesse nyomon a hívást.

  7. Ha befejezte a tesztelést, lépjen ki a tesztkonzolból.

Gyártási megfontolások

  • Az API-k Defender használata az API-k teljes életciklus-védelméhez, észleléséhez és válaszlefedettségéhez.
  • Tekintse meg az API Management SAP-átjáróval való integrálásának végpontok közötti példaforgatókönyvét .
  • API Management-szabályzatok használatával szabályozhatja az SAP-háttérrendszerhez való hozzáférést. Ha például az API OData API-ként van importálva, használja az OData-kérelem érvényesítésére vonatkozó szabályzatot. Az SAP ECC, S/4HANA vagy SAP SuccessFactors SAP főszabályzat továbbítása, valamint X-CSRF token lekérése szabályzatrészletei is elérhetők.
  • Az API-k nagy léptékű üzembe helyezéséről, kezeléséről és migrálásáról a következő témakörben talál útmutatást:

Kapcsolódó tartalom

  • Last updated on