Share via

Importowanie interfejsu API OData

  • Artykuł

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

Uwaga

Importowanie usługi OData jako interfejsu API z opisu metadanych jest w wersji zapoznawczej.

Wymagania wstępne

  • Wystąpienie usługi API Management. Jeśli jeszcze go nie masz, wykonaj czynności opisane w następującym przewodniku Szybki start: Tworzenie wystąpienia usługi Azure API Management.

  • Usługa uwidoczniona jako OData w wersji 2 lub 4.

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

Dołączanie innych interfejsów API

Możesz utworzyć interfejs API interfejsów API udostępnianych przez różne usługi, w tym:

  • Specyfikacja interfejsu OpenAPI
  • Interfejs API PROTOKOŁU SOAP
  • Interfejs API graphQL
  • Aplikacja internetowa hostowana w usłudze aplikacja systemu Azure
  • Aplikacja funkcji platformy Azure
  • Azure Logic Apps
  • Azure Service Fabric

Dołącz inny interfejs API do istniejącego interfejsu API, wykonując następujące kroki.

Uwaga

Po zaimportowaniu innego interfejsu API operacje są dołączane do bieżącego interfejsu API.

  1. Przejdź do wystąpienia Azure API Management w Azure Portal.

    Przejdź do wystąpienia narzędzia Mgmt interfejsu API platformy Azure

  2. Wybierz pozycję Interfejsy API na stronie Przegląd lub z menu po lewej stronie.

    Wybierz interfejsy API

  3. Kliknij przycisk ... obok interfejsu API, który chcesz dołączyć do innego interfejsu API.

  4. Z menu rozwijanego wybierz pozycję Importuj.

    Wybieranie opcji importu

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

    Wybieranie usługi