Importowanie metadanych SAP OData jako interfejsu API

DOTYCZY: Wszystkich poziomów zarządzania API

W tym artykule opisano sposób importowania usługi OData przy użyciu opisu metadanych. Program SAP Gateway Foundation jest używany jako przykład.

W tym artykule dowiesz się:

• Pobieranie metadanych OData z usługi SAP
• Importowanie metadanych OData do usługi Azure API Management bezpośrednio lub po przekonwertowaniu ich na specyfikację interfejsu OpenAPI
• Kompletna konfiguracja interfejsu API
• Testowanie interfejsu API w witrynie Azure Portal

Wymagania wstępne

• Instancja zarządzania API. Jeśli go nie masz, wykonaj kroki w instrukcjach Tworzenie wystąpienia usługi API Management przy użyciu portalu Azure.

• System SAP i usługa uwidoczniona jako OData w wersji 2 lub 4.

• Jeśli zaplecze SAP używa certyfikatu z podpisem własnym (na potrzeby testowania), może być konieczne wyłączenie weryfikacji łańcucha zaufania dla protokołu SSL. W tym celu skonfiguruj zaplecze w wystąpieniu usługi API Management:

  1. W portalu Azure, w obszarze Interfejsy API, wybierz pozycję Zaplecze>+ Dodaj.
  2. Dodaj niestandardowy adres URL wskazujący usługę zaplecza SAP.
  3. Wyczyść pola wyboru Weryfikuj łańcuch certyfikatów i Zweryfikuj nazwę certyfikatu .

  Uwaga / Notatka

  W scenariuszach produkcyjnych użyj odpowiednich certyfikatów na potrzeby kompleksowej weryfikacji SSL.

Pobieranie metadanych OData z usługi SAP

Użyj jednej z następujących metod, aby pobrać kod XML metadanych z usługi SAP. Jeśli planujesz przekonwertować kod XML metadanych na specyfikację interfejsu OpenAPI, zapisz plik lokalnie.

• Użyj klienta SAP Gateway (transakcja /IWFND/GW_CLIENT).
  lub
• Wykonaj bezpośrednie wywołanie HTTP, aby pobrać kod XML: http://<OData server URL>:<port>/<path>/$metadata.

Przejdź do instancji usługi API Management

1. W portalu Azure wyszukaj i wybierz usługi API Management.

   

2. Na stronie zarządzania usługami API wybierz instancję API Management:

   

Importowanie interfejsu API do usługi API Management

Wybierz jedną z następujących metod importowania interfejsu API do usługi API Management:

• Zaimportuj plik XML metadanych bezpośrednio jako interfejs API OData.
• Przekonwertuj kod XML metadanych na specyfikację interfejsu OpenAPI.

Metadane OData

Importowanie metadanych OData

1. W menu po lewej stronie wybierz pozycję Interfejsy API>API, a następnie wybierz pozycję + Dodaj interfejs API.

2. W obszarze Utwórz z definicji wybierz OData:

   

3. Wprowadź ustawienia interfejsu API. Ustawienia można zaktualizować później, przechodząc do karty Ustawienia interfejsu API.

   1. W specyfikacji OData wprowadź adres URL punktu końcowego metadanych OData. Ta wartość jest zazwyczaj adresem URL katalogu głównego usługi, z dołączonym /$metadata. Alternatywnie wybierz lokalny plik XML OData do zaimportowania.

   2. Wprowadź dodatkowe ustawienia, aby skonfigurować interfejs API. Te ustawienia zostały wyjaśnione w samouczku Importowanie i publikowanie pierwszego interfejsu API .

4. Wybierz Utwórz.

   Interfejs API jest dodawany do listy interfejsów API. Zestawy jednostek i funkcje uwidocznione w opisie metadanych OData są wyświetlane na karcie Zestawy jednostek i funkcje interfejsu API.

   

Aktualizowanie schematu OData

Aby wyświetlić schemat OData interfejsu API, możesz uzyskać dostęp do edytora w portalu. Jeśli interfejs API ulegnie zmianie, możesz również zaktualizować schemat w usłudze API Management z pliku lub punktu końcowego usługi OData.

1. W portalu przejdź do instancji usługi zarządzania API.

2. W menu po lewej stronie wybierz pozycję Interfejsy API, a następnie wybierz interfejs API OData.

3. Na karcie Zestawy jednostek i funkcje wybierz wielokropek (...) obok zestawu jednostek lub funkcji, a następnie wybierz pozycję Edytuj.

   

4. Przejrzyj schemat. Jeśli chcesz go zaktualizować, wybierz pozycję Aktualizuj z pliku lub Aktualizuj schemat z punktu końcowego.

   

Przetestuj swoje API OData

1. W menu po lewej stronie wybierz pozycję Interfejsy API, a następnie wybierz interfejs API OData.

2. Na karcie Zestawy jednostek i funkcje wybierz wielokropek (...) obok zestawu jednostek lub funkcji, a następnie wybierz pozycję Testuj.

   

3. W konsoli testowej wprowadź parametry szablonu, parametry zapytania i nagłówki dla testu, a następnie wybierz pozycję Testuj. Aby uzyskać więcej informacji na temat testowania interfejsów API w portalu, zobacz Testowanie nowego interfejsu API w portalu.

Zabezpieczanie interfejsu API OData

Zabezpiecz interfejs API OData, stosując istniejące zasady uwierzytelniania i autoryzacji oraz zasady weryfikacji OData w celu ochrony przed atakami za pośrednictwem żądań interfejsu API OData.

Wskazówka

W portalu skonfiguruj zasady dla interfejsu API OData na karcie Zasady API.

Specyfikacja interfejsu OpenAPI

Konwertowanie metadanych OData na format JSON interfejsu OpenAPI

1. Przekonwertuj format OData XML na format JSON interfejsu OpenAPI. Użyj narzędzia open source OASIS dla OData v2 lub OData v4, w zależności od kodu XML metadanych.

   Poniższy przykład konwertuje kod XML OData w wersji 2 dla usługi epm_ref_apps_prod_man_srvtestowej :

   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
   

   Uwaga / Notatka

   • Do testowania za pomocą pojedynczego pliku XML można użyć konwertera opartego na sieci Web opartego na narzędziu open source.
   • W przypadku narzędzia lub konwertera internetowego określenie <adresu> IP:<portu> serwera SAP OData jest opcjonalne. Alternatywnie dodaj te informacje później w wygenerowanej specyfikacji interfejsu OpenAPI lub po zaimportowaniu pliku do usługi API Management.

2. Zapisz plik lokalnie na potrzeby importowania openapi-spec.json do usługi API Management.

Importowanie specyfikacji interfejsu OpenAPI

1. W okienku nawigacji po lewej stronie w sekcji Interfejsy API wybierz pozycję Interfejsy API.

2. W obszarze Utwórz nową definicję wybierz pozycję OpenAPI:

   

3. Kliknij pozycję Wybierz plik, a następnie wybierz openapi-spec.json plik zapisany lokalnie w poprzednim kroku.

4. Wprowadź ustawienia interfejsu API. Te wartości można ustawić podczas importowania interfejsu API lub konfigurowania ich później, przechodząc do karty Ustawienia .

   • W przypadku sufiksu adresu URL interfejsu API zalecamy użycie tej samej ścieżki adresu URL co oryginalna usługa SAP.

   • Aby uzyskać więcej informacji na temat ustawień interfejsu API, zobacz Importowanie i publikowanie pierwszego samouczka interfejsu API .

5. Wybierz Utwórz.

Uwaga / Notatka

Aby uzyskać informacje na temat ograniczeń importowania interfejsu API, zobacz Ograniczenia importowania interfejsu API i znane problemy.

Ukończ konfigurację interfejsu API

Dodaj następujące trzy operacje do zaimportowanych interfejsów API:

• GET /$metadata

  Operacja	Opis	Dodatkowa konfiguracja operacji
  GET /$metadata	Umożliwia usłudze API Management dotarcie do punktu końcowego $metadata , który jest wymagany do integracji klienta z serwerem OData. Ta wymagana operacja nie jest uwzględniona w specyfikacji interfejsu OpenAPI, która została wygenerowana i zaimportowana.	200 OK Dodaj odpowiedź.

  

• HEAD /

  Operacja	Opis
  HEAD /	Umożliwia klientowi wymianę tokenów fałszerzowania żądań między lokacjami (CSRF) przy użyciu serwera SAP, jeśli jest to wymagane. System SAP umożliwia również wymianę tokenów CSRF za pośrednictwem czasownika GET. Wymiana tokenów CSRF nie jest omówiona w tym artykule. Zobacz przykładowy fragment polityki zarządzania API dotyczący wymiany tokenów.

  

• GET /

  Operacja	Opis	Dodatkowa konfiguracja operacji
  GET /	Umożliwia konfigurację polityk w korzeniu usługi.	Skonfiguruj następującą zasadę rewrite-uri dla ruchu przychodzącego, aby dodawać końcowy ukośnik do żądań przekazywanych do korzenia usługi. <rewrite-uri template="/" copy-unmatched-params="true" /> Ta zasada usuwa potencjalną niejednoznaczność żądań z ukośnikami na końcu i bez nich. Te dwa typy żądań są traktowane inaczej przez niektóre zaplecza.

  

Należy również skonfigurować uwierzytelnianie w zapleczu przy użyciu odpowiedniej metody dla danego środowiska. Przykłady można znaleźć w temacie Api Management authentication and authorization policies (Zasady uwierzytelniania i autoryzacji usługi API Management).

Testowanie interfejsu API

1. Przejdź do instancji usługi zarządzania API.

2. W okienku nawigacji po lewej stronie w sekcji Interfejsy API wybierz pozycję Interfejsy API.

3. W obszarze Wszystkie interfejsy API wybierz zaimportowany interfejs API.

4. Wybierz kartę Test, aby uzyskać dostęp do konsoli testowej.

5. Wybierz operację, wprowadź wymagane wartości, a następnie wybierz pozycję Wyślij.

   Na przykład przetestuj wywołanie GET /$metadata , aby zweryfikować łączność z zapleczem SAP.

6. Wyświetl odpowiedź. Aby rozwiązać problemy, prześledź wywołanie.

7. Po zakończeniu testowania zamknij konsolę testową.

Zagadnienia dotyczące środowiska produkcyjnego

• Zobacz przykładowy scenariusz kompleksowej integracji usługi API Management z bramą SAP.
• Kontrolowanie dostępu do zaplecza SAP przy użyciu zasad usługi API Management. Na przykład, jeśli interfejs API jest importowany jako OData API, użyj zasady weryfikacji żądań OData. Istnieją również fragmenty zasad propagacji głównego SAP dla SAP ECC lub S/4HANA oraz SAP SuccessFactors i pobrania tokenu X-CSRF.
• Aby uzyskać wskazówki dotyczące wdrażania, zarządzania i migrowania interfejsów API na dużą skalę, zobacz:
  • Zautomatyzowane wdrożenia interfejsu API za pomocą metodyki APIOps.
  • CI/CD dla usługi zarządzania API przy użyciu szablonów Azure Resource Manager.

Powiązana zawartość

• Ograniczenia importu interfejsu API
• Importowanie specyfikacji interfejsu OpenAPI
• Importuj API SOAP
• Importowanie interfejsu API protokołu SOAP i przekształcenie go na interfejs API REST
• Importowanie API usługi aplikacji
• Importowanie interfejsu API aplikacji kontenera
• Importuj WebSocket API
• Zaimportuj GraphQL API
• Importowanie schematu GraphQL i konfigurowanie rozpoznawania pól
• Zaimportuj API aplikacji funkcji
• Importowanie interfejsu API aplikacji logicznej
• Importowanie usługi Service Fabric
• Importowanie interfejsu API usługi Azure AI Foundry
• Importowanie interfejsu API usługi Azure OpenAI
• Importowanie interfejsu API LLM
• Importowanie interfejsu API OData
• Importowanie metadanych sap OData
• Zaimportuj API gRPC
• Edytowanie interfejsu API