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

A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint

Ez a cikk bemutatja, hogyan importálhat egy OData-szolgáltatást a metaadatok leírásával. Ebben a cikkben az SAP Gateway Foundation szolgál példaként.

Ebben a cikkben a következőt fogja:

• OData-metaadatok lekérése az SAP-szolgáltatásból
• OData-metaadatok importálása az API Managementbe közvetlenül vagy az OpenAPI-specifikációvá való átalakítás után
• API-konfiguráció befejezése
• Az API tesztelése az Azure Portalon

Előfeltételek

• Egy meglévő API Management-példány. Hozzon létre egyet, ha még nem tette meg.

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

• Ha az SAP-háttérrendszer önaláírt tanúsítványt használ (tesztelési célokra), 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>+ Hozzáadás lehetőséget.
  2. Adjon hozzá egy egyéni URL-címet , amely az SAP háttérszolgáltatásra mutat.
  3. 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.

  Feljegyzés

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

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

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

• Az SAP Gateway-ügyfél (tranzakció /IWFND/GW_CLIENT) használata vagy
• Hozzon létre egy közvetlen HTTP-hívást az XML lekéréséhez: http://<OData server URL>:<port>/<path>/$metadata

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.

   

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

   

API importálása az API Managementbe

Az API API-nak az API Managementbe való importálásához válasszon az alábbi módszerek közül: importálja a metaadat-XML-t közvetlenül OData API-ként, vagy konvertálja a metaadat-XML-t OpenAPI-specifikációvá.

OData-metaadatok

OData-metaadatok importálása

1. A bal oldali menüben válassza az API-k>+ API hozzáadása lehetőséget.

2. A Létrehozás definícióból csoportban válassza az OData lehetőséget.

   

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 URL-címet egy OData metaadat-végponthoz, amely á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. Adja meg a fennmaradó beállításokat az API konfigurálásához. Ezeket a beállításokat az első API-oktatóanyag importálása és közzététele 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.

   

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 OData API API-kat> .

3. Az Entitáskészletek és függvények lapon válassza az entitáskészlet vagy függvény melletti helyi menüt (...), és válassza a Szerkesztés lehetőséget.

   

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 tesztelése

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

2. Az Entitáskészletek és függvények lapon válassza az entitáskészlet vagy függvény melletti helyi menüt (...), majd válassza a Tesztelés lehetőséget.

   

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. További információ az API-k portálon való teszteléséről.

Az OData API védelme

Az OData API biztonságossá tételéhez alkalmazza a meglévő hitelesítési és engedélyezési szabályzatokat , valamint egy OData érvényesítési szabályzatot , amely az OData API-kéréseken keresztüli támadások ellen nyújt védelmet.

Tipp.

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

OpenAPI-specifikáció

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

1. Konvertálja az OData XML-t OpenAPI JSON formátumra. Használjon nyílt forráskódú OData-eszközt oData v2-hez vagy OData v4-hez a metaadatok XML-fájljától függően.

   Az alábbiakban egy példaparancsot láthat az OData v2 XML konvertálásához a tesztszolgáltatáshoz epm_ref_apps_prod_man_srv:

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Feljegyzés

   • Egyetlen XML-fájllal végzett tesztelési célokra használhat egy webes konvertert a nyílt forráskódú eszköz alapján.
   • Az eszköz vagy a webalapú konverter használata esetén az SAP OData-kiszolgáló IP-címének>:<portjának> megadása <nem kötelező. Ezt az információt később is hozzáadhatja a létrehozott OpenAPI-specifikációhoz, vagy az API Managementbe való importálás után.

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

Háttér API importálása és közzététele

1. Az oldalnavigációs menü API-k csoportjában válassza az API-kat.

2. Az Új definíció létrehozása csoportban válassza az OpenAPI-specifikációt.

   

3. Kattintson a Fájl kijelölése elemre, és válassza ki azt a openapi-spec.json fájlt, amelyet az előző lépésben helyileg mentett.

4. Adja meg az API-beállításokat. Az értékeket a létrehozás során állíthatja be, vagy később konfigurálhatja őket a Beállítások lapon.

   • Az API URL-utótagjában azt javasoljuk, hogy ugyanazt az URL-útvonalat használja, mint az eredeti SAP-szolgáltatásban.

   • Az API-beállításokról további információt az első API-oktatóanyag importálása és közzététele című témakörben talál.

5. Válassza a Létrehozás parancsot.

Feljegyzés

Az API importálási korlátozásait egy másik cikkben dokumentáljuk.

API-konfiguráció befejezése

Adja hozzá az alábbi három műveletet az importált API-hoz.

• GET /$metadata

  Művelet	Leírás	További konfigurálás a művelethez
  GET /$metadata	Lehetővé teszi, hogy az API Management elérje a $metadata végpontot, amely az OData-kiszolgálóval való ügyfélintegrációhoz szükséges. Ez a szükséges művelet nem szerepel a létrehozott és importált OpenAPI-specifikációban.	Adjon hozzá egy 200 OK választ.

  

• HEAD /

  Művelet	Leírás	További konfigurálás a művelethez
  HEAD /	Lehetővé teszi, hogy az ügyfél szükség esetén cserélje le a helyek közötti hamisítási (CSRF) jogkivonatokat az SAP-kiszolgálóval. Az SAP a GET paranccsel is engedélyezi a CSRF-jogkivonatok cseréjét. A CSRF-jogkivonatok cseréjére ebben a cikkben nem térünk ki. Tekintse meg a példa API Management-szabályzatrészletet a jogkivonatok cseréjének közvetítéséhez.	n/a

  

• GET /

  Művelet	Leírás	További konfigurálás a művelethez
  GET /	Engedélyezi a szabályzatkonfigurációt a szolgáltatásgyökérnél.	Konfigurálja a következő bejövő újraírási-uri házirendet egy záró perjel hozzáfűzéséhez a szolgáltatásgyökérnek továbbított kérésekhez: <rewrite-uri template="/" copy-unmatched-params="true" /> Ez a szabályzat eltávolítja a kérések esetleges kétértelműségét perjelekkel vagy anélkül, amelyeket egyes háttérrendszerek eltérően kezelnek.

  

Emellett konfigurálja a háttérrendszer hitelesítését a környezetének megfelelő módszerrel. Ilyenek például az API Management hitelesítési és engedélyezési szabályzatai.

Az API tesztelése

1. Lépjen az API Management-példányra.

2. Az oldalnavigációs menü API-k csoportjában válassza az 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, és 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 a tesztelés befejeződött, lépjen ki a tesztkonzolból.

Éles szempontok

• Tekintse meg az API Management SAP-átjáróval való integrálására szolgáló, végpontok közötti példaforgatókönyvet .
• AZ SAP-háttérrendszerhez való hozzáférés szabályozása API Management-szabályzatokkal. 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. Lásd még az SAP egyszerű propagálásának és egy X-CSRF-jogkivonat beolvasásának szabályzatrészleteit.
• Az API-k nagy léptékű üzembe helyezéséhez, kezeléséhez és migrálásához a következő útmutatást talál:
  • Automatizált API-környezetek az APIOps használatával
  • CI/CD az API Managementhez Azure Resource Manager-sablonokkal.

Kapcsolódó témakörök

• API-importálási korlátozások
• OpenAPI-specifikáció importálása
• SOAP API importálása
• SOAP API importálása és konvertálása REST-té
• App Service API importálása
• Container App API importálása
• WebSocket API importálása
• GraphQL API-k importálása
• GraphQL-sémák importálása és mezőfeloldók beállítása
• Azure-függvényalkalmazás importálása
• Azure Logic App-alkalmazás importálása
• Service Fabric-szolgáltatás importálása
• Azure OpenAI API importálása
• OData API importálása
• SAP OData-metaadatok importálása
• GRPC API importálása
• API szerkesztése