Importowanie metadanych sap OData jako interfejsu API

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule pokazano, jak zaimportować usługę OData przy użyciu opisu metadanych. W tym artykule platforma SAP Gateway Foundation służy jako przykład.

W tym artykule wykonasz następujące elementy:

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

Wymagania wstępne

• Istniejące wystąpienie usługi API Management. Utwórz go, jeśli jeszcze tego nie zrobiono.

• 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 witrynie Azure Portal w obszarze Interfejsy API wybierz pozycję Zaplecza>+ Dodaj.
  2. Dodaj niestandardowy adres URL wskazujący usługę zaplecza SAP.
  3. Usuń zaznaczenie pola Weryfikuj łańcuch certyfikatów i Sprawdź poprawność nazwy certyfikatu.

  Uwaga

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

Pobieranie metadanych OData z usługi SAP

Pobierz kod XML metadanych z usługi SAP przy użyciu jednej z następujących metod. Jeśli planujesz przekonwertować kod XML metadanych na specyfikację interfejsu OpenAPI, zapisz plik lokalnie.

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

Przechodzenie do wystąpienia usługi API Management

1. W witrynie Azure Portal wyszukaj i wybierz pozycję Usługi API Management.

   

2. Na stronie Usługi API Management wybierz wystąpienie usługi API Management.

   

Importowanie interfejsu API do usługi API Management

Wybierz jedną z następujących metod, aby zaimportować interfejs API do usługi API Management: zaimportować kod XML metadanych jako interfejs API OData bezpośrednio lub przekonwertować kod XML metadanych na specyfikację interfejsu OpenAPI.

Metadane OData

Importowanie metadanych OData

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

2. W obszarze Utwórz z definicji wybierz pozycję 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, zazwyczaj adres URL do katalogu głównego usługi, dołączany za pomocą /$metadatapolecenia . Alternatywnie wybierz lokalny plik XML OData do zaimportowania.

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

4. Wybierz pozycję 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 wystąpienia usługi API Management.

2. W menu po lewej stronie wybierz pozycję Interfejsy API interfejsu> API OData.

3. Na karcie Zestawy jednostek i funkcje wybierz menu kontekstowe (...) 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.

   

Testowanie interfejsu API OData

1. W menu po lewej stronie wybierz pozycję Interfejsy API interfejsu> API OData.

2. Na karcie Zestawy jednostek i funkcje wybierz menu kontekstowe (...) 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. Dowiedz się więcej na temat testowania interfejsu API w portalu.

Zabezpieczanie interfejsu API OData

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

Napiwek

W portalu skonfiguruj zasady dla interfejsu API OData na karcie Zasady interfejsu 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żej przedstawiono przykładowe polecenie konwertowania kodu 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

   • Do celów testowych z pojedynczym plikiem XML można użyć konwertera internetowego 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 do usługi API Management.

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

Importowanie i publikowanie interfejsu API zaplecza

1. Z menu nawigacji bocznej w sekcji Interfejsy API wybierz pozycję Interfejsy API.

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

   

3. Kliknij pozycję Wybierz plik i wybierz openapi-spec.json plik zapisany lokalnie w poprzednim kroku.

4. Wprowadź ustawienia interfejsu API. Wartości można ustawić podczas tworzenia lub skonfigurować później, przechodząc do karty Ustawienia .

   • W polu Sufiks adresu URL interfejsu API zalecamy używanie tej samej ścieżki adresu URL co w oryginalnej usłudze SAP.

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

5. Wybierz pozycję Utwórz.

Uwaga

Ograniczenia importu interfejsu API są udokumentowane w innym artykule.

Kompletna konfiguracja interfejsu API

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

• GET /$metadata

  Działanie	opis	Dalsza 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 /

  Działanie	opis	Dalsza konfiguracja operacji
  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 przy użyciu czasownika GET. Wymiana tokenów CSRF nie jest omówiona w tym artykule. Zobacz przykładowy fragment kodu zasad usługi API Management do wymiany tokenów brokera.	Nie dotyczy

  

• GET /

  Działanie	opis	Dalsza konfiguracja operacji
  GET /	Włącza konfigurację zasad w katalogu głównym usługi.	Skonfiguruj następujące zasady rewrite-uri dla ruchu przychodzącego, aby dołączyć końcowy ukośnik do żądań przekazywanych do katalogu głównego usługi: <rewrite-uri template="/" copy-unmatched-params="true" /> Te zasady usuwa potencjalną niejednoznaczność żądań z ukośnikami lub bez ukośników, które są traktowane inaczej przez niektóre zaplecza.

  

Ponadto skonfiguruj 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 wystąpienia usługi API Management.

2. Z menu nawigacji bocznej 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śledzić 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. Jeśli na przykład interfejs API jest importowany jako interfejs API OData, użyj zasad weryfikowania żądań OData. Zobacz również fragmenty kodu zasad dotyczące propagacji podmiotu zabezpieczeń SAP i pobierania 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ągła integracja/ciągłe wdrażanie dla usługi API Management przy użyciu szablonów usługi Azure Resource Manager.

Powiązane tematy

• Ograniczenia importu interfejsu API
• Importowanie specyfikacji interfejsu OpenAPI
• Importowanie interfejsu API SOAP
• Importowanie interfejsu API SOAP i konwertowanie go na interfejs API REST
• Importowanie interfejsu API usługi App Service
• Importowanie interfejsu API aplikacji kontenera
• Importowanie interfejsu API protokołu WebSocket
• Importowanie interfejsu GraphQL API
• Importowanie schematu GraphQL i konfigurowanie rozpoznawania pól
• Importowanie aplikacji funkcji platformy Azure
• Importowanie usługi Azure Logic App
• Importowanie usługi Service Fabric
• Importowanie interfejsu API usługi Azure OpenAI
• Importowanie interfejsu API OData
• Importowanie metadanych sap OData
• Importowanie interfejsu API gRPC
• Edytowanie interfejsu API