Udostępnij za pośrednictwem

Importowanie interfejsu API OData

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule pokazano, jak zaimportować usługę zgodną ze standardem OData jako interfejs API w usłudze API Management.

W tym artykule omówiono sposób wykonywania następujących zadań:

  • Importowanie opisu metadanych OData przy użyciu witryny Azure Portal
  • Zarządzanie schematem OData w portalu
  • Zabezpieczanie interfejsu API OData

Wymagania wstępne

Przejdź do instancji usługi API Management

  1. W portalu Azure wyszukaj i wybierz 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 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:

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

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.

    Zrzut ekranu przedstawiający lokalizację polecenia Edytuj.

  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.

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.

    Zrzut ekranu przedstawiający polecenie Test.

  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.

Dołączanie innych interfejsów API

Interfejs API można zbudować z API, które są udostępniane przez różne usługi, w tym:

  • Specyfikacja interfejsu OpenAPI
  • Interfejs SOAP
  • API GraphQL
  • Aplikacja internetowa hostowana w usłudze Azure App Service
  • Funkcje platformy Azure
  • Azure Logic Apps
  • Azure Service Fabric

Uwaga

Podczas importowania interfejsu API operacje są dołączane do bieżącego interfejsu API.

Aby dodać interfejs API do istniejącego:

  1. Przejdź do instancji Azure API Management w portalu Azure.

    Zrzut ekranu przedstawiający stronę usług API Management.

  2. Wybierz interfejsy API na stronie Przegląd lub wybierz interfejsy API>interfejsy API w menu po lewej stronie.

    Zrzut ekranu przedstawiający wybór interfejsów API na stronie przeglądowej.

  3. Wybierz wielokropek (...) obok interfejsu API, do którego chcesz dołączyć inny.

  4. Wybierz Importuj z menu rozwijanego:

    Zrzut ekranu przedstawiający polecenie Importuj.

  5. Wybierz usługę, z której chcesz zaimportować interfejs API.

Powiązana zawartość