Ręczne dodawanie interfejsu API

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule pokazano, jak ręcznie dodać interfejs API do usługi Azure API Management. Gdy chcesz utworzyć pozorowane odpowiedzi interfejsu API, utwórz puste API. Aby uzyskać informacje na temat tworzenia imitacyjnych odpowiedzi API, zapoznaj się z Pozorowanie odpowiedzi API.

Jeśli chcesz zaimportować istniejący interfejs API, zobacz sekcję Powiązana zawartość tego artykułu.

Z tego artykułu dowiesz się, jak utworzyć pusty interfejs API. Określasz httpbin.org (publiczną usługę testową) jako API backend.

Wymagania wstępne

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.

Tworzenie interfejsu API

  1. W obszarze Interfejsy API w menu po lewej stronie wybierz pozycję Interfejsy API.

  2. Wybierz + Dodaj API.

  3. Wybierz kafelek HTTP :

    Zrzut ekranu przedstawiający kafelek HTTP w witrynie Azure Portal.

  4. Wprowadź adres URL usługi internetowej serwera zaplecza (na przykład https://httpbin.org) i inne ustawienia API. Tutorial "Import and publish your first API " wyjaśnia ustawienia.

  5. Wybierz pozycję Utwórz.

Na tym etapie nie masz żadnych operacji w usłudze API Management, które mapują się na operacje w API zaplecza. Jeśli wywołasz operację udostępnioną przez zaplecze, ale nie przez API Management, zostanie wyświetlony błąd 404.

Uwaga

Domyślnie, gdy dodajesz API, nawet jeśli jest połączone z usługą backend, zarządzanie API nie ujawnia żadnych operacji, dopóki na nie nie pozwolisz. Aby umożliwić funkcjonowanie usługi zaplecza, utwórz operację w API Management, która mapuje na operację zaplecza.

Dodawanie i testowanie operacji

W tej sekcji pokazano, jak dodać operację /get , aby zamapować ją na operację zaplecza http://httpbin.org/get .

Dodawanie operacji

  1. Wybierz interfejs API utworzony w poprzednim kroku.
  2. Wybierz pozycję + Dodaj operację.
  3. W polu URL wybierz pozycję GET i wprowadź /get w polu tekstowym.
  4. W polu Nazwa wyświetlana wprowadź FetchData.
  5. Wybierz pozycję Zapisz.

Testowanie operacji

Przetestuj operację w witrynie Azure Portal. (Można go również przetestować w portalu dla deweloperów).

  1. Wybierz kartę Test.
  2. Wybierz pozycję FetchData.
  3. Wybierz Wyślij.

Odpowiedź wygenerowana przez http://httpbin.org/get operację jest wyświetlana w sekcji odpowiedź HTTP . Aby ztransformować swoje operacje, zobacz Transformuj i chroń swoje API.

Dodawanie i testowanie operacji sparametryzowanej

W tej sekcji przedstawiono sposób dodawania operacji przyjmującej parametr. W tym przykładzie przypisujesz operację do http://httpbin.org/status/200.

Dodawanie operacji

  1. Wybierz utworzony wcześniej interfejs API.
  2. Na karcie Projektowanie wybierz pozycję + Dodaj operację.
  3. W URL wybierz opcję GET i wprowadź /status/{code} w polu tekstowym.
  4. W polu Nazwa wyświetlana wprowadź getStatus.
  5. Wybierz pozycję Zapisz.

Testowanie operacji

Przetestuj operację w witrynie Azure Portal. (Można go również przetestować w portalu dla deweloperów).

  1. Wybierz kartę Test.

  2. Wybierz pozycję GetStatus. W kodzie wprowadź wartość 200.

  3. Wybierz Wyślij.

    Odpowiedź wygenerowana przez http://httpbin.org/status/200 operację jest wyświetlana w sekcji odpowiedź HTTP . Aby ztransformować swoje operacje, zobacz Transformuj i chroń swoje API.

Dodaj i przetestuj operację z symbolami wieloznacznymi

W tej sekcji przedstawiono sposób dodawania operacji z symbolami wieloznacznymi. Przy operacji z dziką kartą możesz przekazać dowolną wartość za pomocą żądania API. Zamiast tworzyć oddzielne operacje GET, jak pokazano w poprzednich sekcjach, można utworzyć operację GET z symbolami wieloznacznymi.

Uwaga

Należy zachować ostrożność podczas konfigurowania operacji z symbolami wieloznacznymi. Ta konfiguracja może sprawić, że interfejs API będzie bardziej podatny na określone zagrożenia bezpieczeństwa interfejsu API.

Dodawanie operacji

  1. Wybierz utworzony wcześniej interfejs API.
  2. Na karcie Projektowanie wybierz pozycję + Dodaj operację.
  3. W polu URL wybierz opcję GET i wprowadź /* w polu tekstowym.
  4. W Nazwa wyświetlana wprowadź WildcardGet.
  5. Wybierz pozycję Zapisz.

Testowanie operacji

Przetestuj operację w witrynie Azure Portal. (Można go również przetestować w portalu dla deweloperów).

  1. Wybierz kartę Test.

  2. Wybierz pozycję Symbol wieloznacznyPobierz. Wypróbuj operacje GET przetestowane w poprzednich sekcjach lub spróbuj wykonać inną obsługiwaną operację GET.

    Na przykład w obszarze Parametry szablonu zmień wartość obok symbolu wieloznakowego (*) na nagłówki. Operacja zwraca nagłówki HTTP żądania przychodzącego.

  3. Wybierz Wyślij.

    Odpowiedź wygenerowana przez http://httpbin.org/headers operację jest wyświetlana w sekcji odpowiedź HTTP . Jeśli chcesz przekształcać operacje, zobacz temat Przekształcanie i ochrona interfejsu API.

Uwaga

Ważne jest, aby zrozumieć, jak host interfejsu API zaplecza, z którym się integrujesz, obsługuje końcowe ukośniki w adresach URL operacji. Aby uzyskać więcej informacji, zobacz często zadawane pytania dotyczące usługi API Management.

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
  • Azure Functions
  • Aplikacje logiki Azure
  • 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 paska bocznego.

    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 pozycję Importuj z menu kontekstowego:

    Zrzut ekranu przedstawiający polecenie Importuj.

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

Powiązana zawartość

  • Last updated on