Udostępnij za pośrednictwem


Importowanie aplikacji funkcji Azure jako API

DOTYCZY: Wszystkie warstwy usługi API Management

Usługa Azure API Management obsługuje importowanie aplikacji funkcji platformy Azure jako nowych interfejsów API lub dołączanie ich do istniejących interfejsów API. Proces automatycznie generuje klucz hosta w aplikacji funkcji platformy Azure, która jest następnie przypisywana do nazwanej wartości w usłudze API Management.

W tym artykule opisano sposób importowania aplikacji funkcji platformy Azure jako interfejsu API do usługi Azure API Management i testowania interfejsu API.

Uwaga

Obecnie ta funkcja nie jest dostępna w obszarach roboczych.

W tym artykule dowiesz się, jak:

  • Importowanie aplikacji funkcji Azure jako API
  • Dołączanie aplikacji funkcji platformy Azure do interfejsu API
  • Wyświetlanie nowego klucza hosta aplikacji funkcji i usługi API Management o nazwie value
  • Testowanie interfejsu API w witrynie Azure Portal

Wymagania wstępne

Uwaga

Możesz również użyć rozszerzenia usługi API Management dla programu Visual Studio Code do importowania interfejsów API i zarządzania nimi. Aby rozpocząć, ukończ samouczek dotyczący rozszerzenia usługi API Management.

Importowanie aplikacji funkcji platformy Azure jako nowego interfejsu API

Aby utworzyć nowy interfejs API z poziomu aplikacji funkcji platformy Azure:

  1. Przejdź do usługi API Management w witrynie Azure Portal.

  2. W menu paska bocznego wybierz pozycję API>API, a następnie wybierz pozycję + Dodaj API.

  3. W obszarze Utwórz z zasobu platformy Azure wybierz kafelek Aplikacja funkcyjna:

    Zrzut ekranu przedstawiający kafelek Function App w Azure Portal.

  4. Wybierz przycisk Przeglądaj :

    Zrzut ekranu przedstawiający przycisk Przeglądaj.

  5. Kliknij przycisk Wybierz w obszarze Konfiguruj wymagane ustawienia , aby wybrać z listy dostępnych aplikacji funkcji:

    Zrzut ekranu przedstawiający przycisk Wybierz.

  6. Znajdź aplikację funkcji, z której chcesz zaimportować funkcje, wybierz ją, a następnie kliknij pozycję Wybierz:

    Zrzut ekranu przedstawiający aplikację funkcji i przycisk Wybierz.

  7. Wybierz funkcje, które chcesz zaimportować, a następnie kliknij pozycję Wybierz. Można importować tylko funkcje, które mają wyzwalacz HTTP i poziom autoryzacji anonimowej lub funkcji .

    Zrzut ekranu przedstawiający funkcję i przycisk Wybierz.

  8. Przejdź do widoku Pełny i przypisz produkt do nowego interfejsu API.

    Uwaga

    Produkty są powiązaniami z jednym lub więcej interfejsami API, które są oferowane deweloperom za pośrednictwem portalu dla deweloperów. Najpierw deweloperzy muszą subskrybować produkt, aby uzyskać dostęp do interfejsu API. Gdy subskrybują, otrzymają klucz subskrypcji dla dowolnego interfejsu API w produkcie. Jeśli utworzono wystąpienie usługi API Management, jesteś administratorem i domyślnie subskrybujesz każdy produkt.

    W niektórych poziomach cen, wystąpienia usługi API Management zawierają dwa domyślne przykładowe produkty.

    • Rozrusznik
    • Unlimited (nieograniczony)
  9. W razie potrzeby określ inne ustawienia. Ustawienia można również określić później za pomocą karty Ustawienia . Te ustawienia zostały wyjaśnione w samouczku Importowanie i publikowanie pierwszego interfejsu API .

  10. Wybierz Utwórz.

Dołącz aplikację funkcjonalną do istniejącego interfejsu API

Aby dołączyć aplikację funkcji do istniejącego interfejsu API:

  1. W wystąpieniu usługi Azure API Management wybierz pozycję Interfejsy API>API w menu paska bocznego.

  2. Wybierz interfejs API, do którego chcesz zaimportować aplikację funkcjonalną. Wybierz wielokropek (...) obok interfejsu API, a następnie wybierz Importuj:

    Zrzut ekranu przedstawiający opcję menu Importuj.

  3. Wybierz kafelek Aplikacja funkcji :

    Zrzut ekranu przedstawiający kafelek Aplikacja funkcji.

  4. W oknie Importowanie z aplikacji funkcji wybierz pozycję Przeglądaj:

    Zrzut ekranu przedstawiający przycisk Przeglądaj.

  5. Kliknij przycisk Wybierz w obszarze Konfiguruj wymagane ustawienia , aby wybrać z listy dostępnych aplikacji funkcji:

    Zrzut ekranu przedstawiający sekcję Aplikacja funkcji.

  6. Znajdź aplikację funkcji, z której chcesz zaimportować funkcje, wybierz ją, a następnie kliknij pozycję Wybierz:

    Zrzut ekranu przedstawiający aplikację funkcji i przycisk Wybierz.

  7. Wybierz funkcje, które chcesz zaimportować, a następnie kliknij pozycję Wybierz:

    Zrzut ekranu przedstawiający listę funkcji.

  8. Wybierz pozycję Importuj:

    Zrzut ekranu przedstawiający przycisk Importuj.

Autoryzacja

Podczas importowania aplikacji funkcji platformy Azure te elementy są generowane automatycznie:

  • Klucz hosta w aplikacji funkcji. Klucz ma nazwę apim-<your API Management service instance name>.
  • Nazwana wartość w wystąpieniu usługi API Management o nazwie <your Azure function app instance name>-key. Ta wartość zawiera klucz hosta.

W przypadku interfejsów API utworzonych po 4 kwietnia 2019 r. klucz hosta jest przekazywany w żądaniach HTTP z usługi API Management do aplikacji funkcji w nagłówku. Starsze interfejsy API przekazują klucz hosta jako parametr zapytania. Możesz zmienić to zachowanie, używając wywołania PATCH Backend API REST na Backend jednostce powiązanej z aplikacją funkcjonalną.

Ostrzeżenie

Usunięcie lub zmiana wartości klucza hosta aplikacji Azure Functions lub wartości o nazwie w usłudze API Management powoduje przerwanie komunikacji między usługami. Wartości nie są automatycznie synchronizowane.

Jeśli musisz obrócić klucz hosta, pamiętaj również o zmianie nazwanej wartości w zarządzaniu API.

Uzyskiwanie dostępu do klucza hosta aplikacji funkcyjnej

  1. Przejdź do wystąpienia aplikacji funkcji platformy Azure:

    Zrzut ekranu przedstawiający listę wystąpień aplikacji funkcji.

  2. W sekcji Funkcje menu paska bocznego wybierz pozycję Klucze aplikacji. Znajdź klucze w sekcji Klucze hosta :

    Zrzut ekranu przedstawiający klucze aplikacji w menu.

Uzyskiwanie dostępu do nazwanej wartości w usłudze API Management

Przejdź do wystąpienia usługi API Management i wybierz pozycję Interfejsy> APINazwane wartości w menu paska bocznego. Klucz aplikacji funkcji platformy Azure jest tam przechowywany.

Zrzut ekranu przedstawiający lokalizację klucza aplikacji funkcji.

Testowanie nowego interfejsu API w witrynie Azure Portal

Operacje można wywoływać bezpośrednio w witrynie Azure Portal. Witryna Azure Portal to wygodny sposób wyświetlania i testowania operacji interfejsu API.

Zrzut ekranu przedstawiający kroki testowania interfejsu API.

  1. Wybierz interfejs API utworzony w poprzedniej sekcji.

  2. Wybierz kartę Test.

  3. Wybierz operację, którą chcesz przetestować.

    • Na stronie są wyświetlane pola parametrów zapytania i nagłówków.
    • Jednym z nagłówków jest Ocp-Apim-Subscription-Key. Ten nagłówek dotyczy klucza subskrypcji produktu skojarzonego z interfejsem API.
    • Jeśli utworzono wystąpienie usługi API Management, jesteś administratorem, więc klucz jest wypełniany automatycznie.
  4. Wybierz Wyślij.

    Po pomyślnym zakończeniu testu zaplecze odpowiada kodem 200 OK i danymi.