Udostępnij za pośrednictwem


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.

    Wybieranie usług API Management

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

    Wybieranie wystąpienia 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.

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.

    Zrzut ekranu przedstawiający tworzenie interfejsu API na podstawie opisu OData w portalu.

  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.

    Zrzut ekranu przedstawiający zestawy jednostek I funkcje OData w portalu.

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.

    Zrzut ekranu przedstawiający menu kontekstowe dla zestawu jednostek OData w portalu.

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

    Zrzut ekranu przedstawiający edytor schematu dla interfejsu API OData w portalu.

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.

    Zrzut ekranu przedstawiający opcję Testuj w menu kontekstowym dla jednostki OData ustawionej w portalu.

  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.

Zagadnienia dotyczące środowiska produkcyjnego