Importowanie metadanych SAP OData jako interfejsu API

DOTYCZY: Wszystkich poziomów zarządzania API

W tym artykule opisano sposób importowania usługi OData (Open Data Protocol) do usługi Azure API Management przy użyciu metadanych OData. W poniższym przykładzie użyto programu SAP Gateway Foundation.

W tym artykule dowiesz się, jak:

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

Wymagania wstępne

  • Utwórz wystąpienie usługi API Management.

  • 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>+ Utwórz nowe zaplecze.
    2. Dodaj niestandardowy adres URL wskazujący usługę zaplecza SAP.
    3. Rozwiń sekcję Zaawansowane , a następnie wyczyść pola wyboru Weryfikuj łańcuch certyfikatów i Sprawdź poprawność nazwy certyfikatu .

    Uwaga / Notatka

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

    Wskazówka

    Aby uzyskać pełny zakres funkcji usługi API Management, przed zarejestrowaniem przekonwertuj specyfikację interfejsu API SAP OData na specyfikację interfejsu OpenAPI.

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).
  • Wykonaj bezpośrednie wywołanie HTTP, aby pobrać kod XML: http://<OData server URL>:<port>/<path>/$metadata.
  • Jeśli to możliwe, użyj SAP Business Accelerator Hub.

Przejdź do instancji usługi API Management

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

    Zrzut ekranu przedstawiający usługi API Management w wynikach wyszukiwania.

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

    Zrzut ekranu przedstawiający instancję zarządzania API na stronie usług zarządzania API.

Importowanie interfejsu API do usługi API Management

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

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

Konwertowanie metadanych OData na format JSON interfejsu OpenAPI

  1. Użyj konwertera Microsoft opartego na narzędziu open source OASIS.

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

    oasis-converter convert epm_ref_apps_prod_man_srv.xml api.json

    Uwaga / Notatka

    Do testowania za pomocą jednego pliku XML można użyć środowiska internetowego.

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

Importowanie specyfikacji interfejsu OpenAPI

  1. W menu paska bocznego w sekcji Interfejsy API wybierz pozycję Interfejsy API.

  2. W obszarze Utwórz z definicji wybierz kafelek OpenAPI :

    Zrzut ekranu przedstawiający kafelek OpenAPI.

  3. Wybierz Wybierz plik, a następnie wybierz plik openapi-spec.json 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 .

  5. Wybierz Utwórz.

Należy również skonfigurować uwierzytelnianie w zapleczu przy użyciu odpowiedniej metody dla danego środowiska. Aby zapoznać się z przykładami, zobacz Uwierzytelnianie i autoryzacja.

Uwaga / Notatka

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

Testowanie interfejsu API

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

  2. W menu paska bocznego wybierz pozycję Interfejsy API>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

Powiązana zawartość

  • Last updated on