Połączenie lub wywoływanie punktów końcowych interfejsu API REST z przepływów pracy w usłudze Azure Logic Apps
Dotyczy: Azure Logic Apps (Zużycie + Standardowa)
Aby wywołać punkt końcowy interfejsu API REST z przepływu pracy aplikacji logiki w usłudze Azure Logic Apps, możesz użyć wbudowanych operacji HTTP + Swagger do wywoływania dowolnego punktu końcowego interfejsu API REST za pośrednictwem pliku struktury Swagger. Wyzwalacz HTTP + Swagger i akcja działają tak samo jak wyzwalacz HTTP i akcja, ale zapewniają lepsze środowisko w projektancie przepływu pracy, uwidaczniając strukturę interfejsu API i dane wyjściowe opisane przez plik Swagger. Aby zaimplementować wyzwalacz sondowania, postępuj zgodnie ze wzorcem sondowania opisanym w temacie Tworzenie niestandardowych interfejsów API w celu wywoływania innych interfejsów API, usług i systemów z przepływów pracy aplikacji logiki.
Ograniczenia
Wbudowane operacje HTTP + Swagger obsługują obecnie tylko interfejs OpenAPI 2.0, a nie OpenAPI 3.0.
Wymagania wstępne
Konto i subskrypcja platformy Azure. Jeśli nie masz subskrypcji platformy Azure, zarejestruj się w celu założenia bezpłatnego konta platformy Azure.
Adres URL pliku struktury Swagger opisujący docelowy punkt końcowy interfejsu API REST, który chcesz wywołać
Zazwyczaj punkt końcowy REST musi spełniać następujące kryteria wyzwalacza lub akcji do działania:
Plik struktury Swagger musi być hostowany pod adresem URL HTTPS, który jest publicznie dostępny.
Plik Struktury Swagger musi zawierać właściwość operationID dla każdej operacji w definicji. Jeśli nie, łącznik pokazuje tylko ostatnią operację w pliku Swagger.
Plik struktury Swagger musi mieć włączoną funkcję współużytkowania zasobów między źródłami (CORS ).
W przykładach w tym przewodniku jest używana funkcja rozpoznawania sztucznej inteligencji platformy Azure, która wymaga klucza zasobu i regionu usług Azure AI.
Uwaga
Aby odwołać się do pliku struktury Swagger, który nie jest hostowany lub nie spełnia wymagań dotyczących zabezpieczeń i między źródłami, możesz przekazać plik struktury Swagger do kontenera obiektów blob na koncie usługi Azure Storage i włączyć mechanizm CORS na tym koncie magazynu, aby można było odwoływać się do tego pliku.
Przepływ pracy aplikacji logiki Zużycie lub Standardowa, z którego chcesz wywołać docelowy punkt końcowy. Aby rozpocząć od wyzwalacza HTTP + Swagger , utwórz zasób aplikacji logiki z pustym przepływem pracy. Aby użyć akcji HTTP + Swagger , uruchom przepływ pracy z dowolnym wyzwalaczem. W tym przykładzie użyto wyzwalacza HTTP + Swagger jako pierwszej operacji.
Dodawanie wyzwalacza HTTP + Swagger
Ten wbudowany wyzwalacz wysyła żądanie HTTP do adresu URL pliku struktury Swagger, który opisuje interfejs API REST. Wyzwalacz zwraca następnie odpowiedź zawierającą zawartość tego pliku.
W witrynie Azure Portal otwórz zasób standardowej aplikacji logiki i pusty przepływ pracy w projektancie.
W projektancie wykonaj następujące ogólne kroki, aby dodać wyzwalacz HTTP o nazwie HTTP + Swagger.
W polu Punkt końcowy struktury Swagger wprowadź adres URL żądanego pliku struktury Swagger, a następnie wybierz pozycję Dodaj akcję.
Pamiętaj, aby użyć lub utworzyć własny punkt końcowy. Na przykład te kroki korzystają tylko z następującego adresu URL programu Swagger interfejsu API rozpoznawania twarzy usługi Azure AI znajdującego się w regionie Zachodnie stany USA i mogą nie działać w określonym wyzwalaczu:
https://westus.dev.cognitive.microsoft.com/docs/services/563879b61984550e40cbbe8d/export?DocumentFormat=Swagger&ApiName=Face%20API%20-%20V1.0
Gdy projektant wyświetli operacje opisane w pliku Swagger, wybierz operację, której chcesz użyć.
Poniższy przykład zmienia nazwę wyzwalacza na Face — Detect , aby wyzwalacz miał bardziej opisową nazwę.
Podaj wartości parametrów wyzwalacza, które różnią się w zależności od wybranej operacji, które mają zostać uwzględnione w wywołaniu punktu końcowego. Skonfiguruj cykl tak, jak często wyzwalacz ma wywoływać punkt końcowy.
Aby dodać inne dostępne parametry, otwórz listę Parametry zaawansowane i wybierz żądane parametry.
Aby uzyskać więcej informacji na temat typów uwierzytelniania dostępnych dla protokołu HTTP + Swagger, zobacz Dodawanie uwierzytelniania do wywołań wychodzących.
Kontynuuj tworzenie przepływu pracy, korzystając z akcji, które chcesz uruchomić po uruchomieniu wyzwalacza.
Gdy wszystko będzie gotowe, zapisz proces. Na pasku narzędzi projektanta wybierz pozycję Zapisz.
Dodawanie akcji HTTP + Swagger
Ta wbudowana akcja wysyła żądanie HTTP do adresu URL pliku struktury Swagger, który opisuje interfejs API REST. Następnie akcja zwraca odpowiedź zawierającą zawartość tego pliku.
W witrynie Azure Portal otwórz zasób aplikacji logiki w warstwie Standardowa i przepływ pracy w projektancie.
W projektancie wykonaj następujące ogólne kroki, aby dodać akcję HTTP o nazwie HTTP + Swagger.
W polu Punkt końcowy struktury Swagger wprowadź adres URL żądanego pliku struktury Swagger, a następnie wybierz pozycję Dodaj akcję.
Pamiętaj, aby użyć lub utworzyć własny punkt końcowy. Na przykład te kroki korzystają tylko z następującego adresu URL programu Swagger interfejsu API rozpoznawania twarzy usługi Azure AI znajdującego się w regionie Zachodnie stany USA i mogą nie działać w określonym wyzwalaczu:
https://westus.dev.cognitive.microsoft.com/docs/services/563879b61984550e40cbbe8d/export?DocumentFormat=Swagger&ApiName=Face%20API%20-%20V1.0
Gdy projektant wyświetli operacje opisane w pliku Swagger, wybierz operację, której chcesz użyć.
Poniższy przykład zmienia nazwę akcji na Rozpoznawanie twarzy — zidentyfikuj , aby akcja ma bardziej opisową nazwę.
Podaj wartości parametrów akcji, które różnią się w zależności od wybranej operacji, które mają zostać uwzględnione w wywołaniu punktu końcowego.
Aby dodać inne dostępne parametry, otwórz listę Parametry zaawansowane i wybierz żądane parametry.
Aby uzyskać więcej informacji na temat typów uwierzytelniania dostępnych dla protokołu HTTP + Swagger, zobacz Dodawanie uwierzytelniania do wywołań wychodzących.
Kontynuuj tworzenie przepływu pracy przy użyciu innych akcji, które chcesz uruchomić.
Gdy wszystko będzie gotowe, zapisz proces. Na pasku narzędzi projektanta wybierz pozycję Zapisz.
Hostowanie programu Swagger w usłudze Azure Storage
Nadal można odwołać się do pliku struktury Swagger, który nie jest hostowany lub który nie spełnia wymagań dotyczących zabezpieczeń i między źródłami. Przekaż plik struktury Swagger do kontenera obiektów blob na koncie usługi Azure Storage i włącz mechanizm CORS na tym koncie magazynu. Aby utworzyć, skonfigurować i przechowywać pliki struktury Swagger w usłudze Azure Storage, wykonaj następujące kroki:
Teraz włącz mechanizm CORS dla obiektu blob. W menu konta magazynu wybierz pozycję CORS. Na karcie Blob Service określ te wartości, a następnie wybierz pozycję Zapisz.
Właściwości Wartość Dozwolone źródła *Dozwolone metody GET, ,HEADPUTDozwolone nagłówki *Uwidocznione nagłówki *Maksymalny wiek (w sekundach) 200Mimo że w tym przykładzie użyto witryny Azure Portal, możesz użyć narzędzia takiego jak Eksplorator usługi Azure Storage lub automatycznie skonfigurować to ustawienie przy użyciu tego przykładowego skryptu programu PowerShell.
Utwórz kontener obiektów blob. W okienku Przegląd kontenera wybierz pozycję Zmień poziom dostępu. Z listy Poziom dostępu publicznego wybierz pozycję Blob (anonimowy dostęp do odczytu tylko dla obiektów blob) i wybierz przycisk OK.
Przekaż plik struktury Swagger do kontenera obiektów blob za pośrednictwem witryny Azure Portal lub Eksplorator usługi Azure Storage.
Aby odwołać się do pliku w kontenerze obiektów blob, pobierz adres URL HTTPS zgodny z tym formatem, który jest uwzględniany w wielkości liter, z Eksplorator usługi Azure Storage:
https://<storage-account-name>.blob.core.windows.net/<blob-container-name>/<complete-swagger-file-name>?<query-parameters>
dokumentacja techniczna Połączenie or
Ta sekcja zawiera więcej informacji na temat danych wyjściowych wyzwalacza HTTP + swagger i akcji.
Dane wyjściowe
Wywołanie HTTP + Swagger zwraca następujące informacje:
| Nazwa właściwości | Typ | Opis |
|---|---|---|
| Nagłówki | Objekt | Nagłówki żądania |
| treść | Objekt | Obiekt z zawartością treści żądania |
| kod stanu | Integer | Kod stanu żądania |
| Kod stanu | opis |
|---|---|
| 200 | OK |
| 202 | Zaakceptowano |
| 400 | Nieprawidłowe żądanie |
| 401 | Brak autoryzacji |
| 403 | Dostęp zabroniony |
| 404 | Nie znaleziono |
| 500 | Wewnętrzny błąd serwera. Wystąpił nieznany błąd. |