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

A KÖVETKEZŐRE VONATKOZIK: Az összes API kezelési szint

Ez a cikk azt ismerteti, hogyan importálhat OData-szolgáltatást a metaadatok leírásával. Példaként az SAP Gateway Foundationt használjuk.

Ebben a cikkben a következőt találja:

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

Előfeltételek

• API Management-példány. Ha nem rendelkezik ilyenvel, hajtsa végre az API Management-példány létrehozásának lépéseit az Azure Portal használatával.

• 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>
  2. Adjon hozzá egy egyéni URL-címet , amely az SAP háttérszolgáltatásra mutat.
  3. Törölje a tanúsítványlánc érvényesítése és a tanúsítványnév ellenőrzése jelölőnégyzet jelölését.

  Megjegyzé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 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).
  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 portálonkeresse meg és válassza ki a 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

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

• Importálja a metaadat-XML-t közvetlenül OData API-ként.
• 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-kat>, majd kattintson az + API hozzáadása gombra.

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

   

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 Az első API importálása és közzététele 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.

   

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.

   

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 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.

   

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.

OpenAPI-specifikáció

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

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

   Az alábbi példa az OData v2 XML-t konvertálja 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
   

   Megjegyzés:

   • Egyetlen XML-fájllal végzett teszteléshez használhat nyílt forráskódú eszközre épülő webalapú konvertert .
   • 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ő. Azt is megteheti, hogy később hozzáadja ezeket az információkat a létrehozott OpenAPI-specifikációhoz, vagy miután importálta a fájlt az API Managementbe.

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

OpenAPI-specifikáció importálása

1. A bal oldali navigációs panel API-k szakaszában válassza az API-kat.

2. Az Új definíció létrehozása csoportban válassza az OpenAPI lehetőséget:

   

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

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.

   • Az API URL-utótagja esetében azt javasoljuk, hogy ugyanazt az URL-útvonalat használja, mint az eredeti SAP-szolgáltatásé.

   • 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 lehetőséget.

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-konfiguráció befejezése

Adja hozzá a következő három műveletet az importált API-hoz:

• GET /$metadata

  Művelet	Leírás	A művelet további konfigurációja
  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
  HEAD /	Lehetővé teszi az ügyfél számára a webhelyek közötti kérelemhamisítási (CSRF) tokenek cseréjét az SAP-kiszolgálóval, ha szükséges. Az SAP lehetővé teszi a CSRF-jogkivonatok cseréjét a GET ige használatával is. 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.

  

• GET /

  Művelet	Leírás	A művelet további konfigurációja
  GET /	Engedélyezi a szabályzatkonfigurációt a szolgáltatás gyökerénél.	Konfigurálja a következő bejövő újraírási-uri házirendet, hogy hozzáfűzjön egy záró perjelet a szolgáltatásgyökérnek továbbított kérésekhez: <rewrite-uri template="/" copy-unmatched-params="true" /> Ez az irányelv eltávolítja a lehetséges kétértelműséget a perjelet tartalmazó és nem tartalmazó kérések között. Ezt a két kéréstípust egyes háttérrendszerek eltérően kezelik.

  

Emellett konfigurálnia kell a háttérrendszer hitelesítését is a környezetéhez megfelelő módszer használatával. Ilyenek például az API Management hitelesítési és engedélyezési szabályzatai.

Az API tesztelése

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

2. A bal oldali navigációs panel API-k szakaszá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, 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

• 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 fő propagálásához az SAP ECC vagy S/4HANA, illetve az SAP SuccessFactors esetében, továbbá egy X-CSRF-jogkivonat lekéréséhez is léteznek kódrészletek.
• 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:
  • Automatizált API-környezetek az APIOps használatával.
  • CI/CD az API-kezeléshez az Azure Resource Manager-sablonok használatával.

Kapcsolódó tartalom

• API-importálási korlátozások
• OpenAPI-specifikáció importálása
• SOAP API importálása
• Egy SOAP API importálása és REST konvertálása
• App Service API importálása
• Tárolóalkalmazás 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
• Függvényalkalmazás API importálása
• Logikai alkalmazás API importálása
• Service Fabric-szolgáltatás importálása
• Azure AI Foundry API importálása
• Azure OpenAI API importálása
• LLM API importálása
• OData API importálása
• SAP OData-metaadatok importálása
• GRPC API importálása
• API szerkesztése