Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Z tego tematu dowiesz się, jak tworzyć proksy API dla usług internetowych opartych na protokole SOAP. W Edge możesz utworzyć 2 rodzaje serwerów proxy SOAP. Jeden z nich generuje interfejs RESTful dla backendu usługi SOAP, a drugi przepuszcza komunikat SOAP do backendu. W tym temacie opisano obie te techniki.
Ten film przedstawia kompleksową demonstrację przekształcania usługi SOAP w usługę REST za pomocą interfejsu Apigee Edge i kreatora proxy API. Jeśli jednak chcesz mieć większą kontrolę nad przekształcaniem SOAP w REST, możesz utworzyć serwer proxy za pomocą zasad. Więcej informacji znajdziesz w artykule Samouczek: ręczne tworzenie wtyczki SOAP-to-REST API w usłudze Apigee Edge.
Tworzenie proxy interfejsu RESTful API do usługi opartej na protokole SOAP
W tej sekcji opisano, jak utworzyć serwer proxy interfejsu API RESTful SOAP za pomocą opcji REST to SOAP to REST w kreatorze tworzenia serwera proxy.
Omówienie
Opcja REST to SOAP to REST przetwarza plik WSDL, aby wygenerować interfejs API typu REST. Z pliku WSDL Edge określa obsługiwane operacje usługi, parametry wejściowe itp. Edge „zgaduje”, której metody HTTP użyć w przypadku danej operacji. Zwykle Edge przekształca operacje w żądania GET, które mają tę zaletę, że można je przechowywać w pamięci podręcznej. Edge konfiguruje też punkt końcowy docelowy backendu, który może się różnić w zależności od operacji SOAP.
W przypadku tego typu serwera proxy Edge automatycznie generuje specyfikację OpenAPI, której możesz użyć do utworzenia dokumentacji interfejsu API.
Podstawowe czynności
Edge
Aby utworzyć serwer proxy interfejsu API REST do usługi opartej na protokole SOAP za pomocą interfejsu Edge:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Rozwijaj > Proxy interfejsu API.
- Kliknij +Proxy.
- Kliknij Usługa SOAP.
- Na stronie Szczegóły serwera proxy podaj plik WSDL.
Pole Opis Przesyłanie pliku WSDL Wybierz źródło pliku WSDL.
- Z adresu internetowego (URL) – wpisz lub wklej adres URL pliku WSDL.
- Z mojego komputera – prześlij plik WSDL z katalogu lokalnego. Jeśli występują zależności, możesz przesłać wiele plików.
- Aby zweryfikować plik WSDL, kliknij Sprawdź.
- Podaj te informacje o serwerze proxy:
Pole Opis Nazwa Wyświetlana nazwa interfejsu API. Podaj znaki alfanumeryczne, łącznik (-) lub podkreślenie (_). Ścieżka podstawowa Fragment URI, który pojawia się po adresie http(s)://[host] serwera proxy API. Edge używa identyfikatora URI ścieżki podstawowej do dopasowywania przychodzących wiadomości żądań i przekierowywania ich do odpowiedniego serwera proxy API.
UWAGA: ścieżka podstawowa serwera proxy interfejsu API jest domyślnie ustawiona na wartość określoną w polu
Name
, ale w wersji z małą litery.Po ścieżce podstawowej znajdują się wszystkie dodatkowe adresy URL zasobów. Oto pełna struktura adresu URL, której klienci będą używać do wywoływania proxy interfejsu API:
https://[host]/base_path/conditional_flow_path
UWAGA: ścieżka podstawowa musi być unikalna. Nie można wdrożyć 2 przekaźników interfejsu API z tą samą ścieżką podstawową. Jeśli edytujesz wdrożony serwer proxy interfejsu API i ustawiasz ścieżkę podstawową na taką samą jak ścieżka podstawowa innego serwera proxy interfejsu API, Edge automatycznie wycofuje serwer proxy interfejsu API, gdy go zapiszesz. Zanim ponownie wdrożysz serwer proxy interfejsu API, musisz zmienić ścieżkę podstawową, aby była unikalna.
Używanie symboli wieloznacznych w ścieżkach bazowych
Użyj co najmniej 1 symbolu zastępczego
/*/
w ścieżkach podstawowych serwerów proxy interfejsu API, aby zapewnić ich zgodność z przyszłością. Na przykład ścieżka podstawowa/team/*/members
umożliwia klientom wywoływanie adresówhttps://[host]/team/blue/members
ihttps://[host]/team/green/members
bez konieczności tworzenia nowych serwerów proxy interfejsu API na potrzeby nowych zespołów. Uwaga:/**/
nie jest obsługiwany.Opis (Opcjonalnie) Opis interfejsu API. - Kliknij Dalej.
- Na stronie kreatora Wspólne zasady skonfiguruj te ustawienia:
- Wymagania dotyczące autoryzacji zabezpieczeń w sekcji Bezpieczeństwo: autoryzacja. Zobacz Dodawanie zabezpieczeń.
- Obsługa współdzielenia zasobów pomiędzy serwerami z różnych domen (CORS) w sekcji Bezpieczeństwo: przeglądarka. Zobacz Dodawanie obsługi CORS.
- Limity, które chronią usługę backendową przed dużym ruchem w ramach limitu. Zobacz artykuł Limity. (niedostępne, jeśli wybrana jest autoryzacja typu pass-through)
- Na stronie Operacje WSDL wybierz typ serwera proxy API REST na SOAP na REST.
Pojawi się tabela z wykazaniem operacji, które Edge „odkrył” w pliku WSDL. Możesz wybrać i skonfigurować operacje, które chcesz uwzględnić w proxy interfejsu API. Tabela jest przedstawiona na rysunku poniżej.
- W menu wybierz Typ portu, aby określić, którego zestawu operacji chcesz użyć. W WSDL elementy typu port określają operacje, które możesz wywoływać w usłudze internetowej.
- Opcjonalnie zmień ścieżkę interfejsu API REST dla danej operacji. Ścieżka będzie używana jako nazwa zasobu w adresie URL serwera proxy interfejsu API.
- Opcjonalnie zmień Przekaz (metodę HTTP) powiązany z operacją.
- Kliknij Dalej.
- Na stronie kreatora Hosty wirtualnych wybierz hosty wirtualnych, z którymi serwer proxy API będzie powiązany po wdrożeniu. Więcej informacji znajdziesz w artykule Informacje o hostach wirtualnych.
- Kliknij Dalej.
- Wybierz środowisko(-a) wdrażania i kliknij Utwórz i wdróż
Nowe proxy interfejsu API zostanie utworzone i wdrożone w wybranym środowisku. - Kliknij Edytuj proxy, aby wyświetlić stronę szczegółów proxy API.
Classic Edge (Private Cloud)
Aby utworzyć serwer proxy interfejsu RESTful API dla usługi opartej na protokole SOAP za pomocą interfejsu klasycznej wersji przeglądarki Edge:
- Zaloguj się na stronie
http://ms-ip:9000
, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. - Na górnym pasku nawigacyjnym kliknij Interfejsy API > Proxy interfejsów API.
- Kliknij + Serwer proxy interfejsu API.
- W kreatorze tworzenia usługi proxy wybierz usługę SOAP.
- Kliknij Dalej.
- Na stronie Szczegóły wybierz: Po wybraniu pliku WSDL musisz kliknąć Weryfikuj.
W tym polu wykonaj to WSDL Wybierz źródło pliku WSDL.
- URL – wpisz adres URL pliku WSDL, którego chcesz użyć.
- Plik – wybierz plik WSDL w systemie plików. W przypadkach, gdy istnieją dodatkowe pliki zależne, możesz je wszystkie zaznaczyć.
- Przykładowy adres URL – wybierz z listy plików WSDL publicznie dostępnych usług internetowych. Są one przydatne do testowania funkcji proxy SOAP/API w Edge.
Nazwa serwera proxy To nazwa tworzonego serwera proxy.
Ścieżka podstawowa proxy Fragment URI, który pojawia się po adresie http(s)://[host] serwera proxy API. Edge używa identyfikatora URI ścieżki podstawowej do dopasowywania przychodzących wiadomości żądań i przekierowywania ich do odpowiedniego serwera proxy interfejsu API.
Uwaga: ścieżka podstawowa serwera proxy interfejsu API jest domyślnie ustawiona na wartość określoną w polu
Name
, ale w wersji w pełni w małej literze.Po ścieżce podstawowej znajdują się wszystkie dodatkowe adresy URL zasobów. Oto pełna struktura adresu URL, której klienci będą używać do wywoływania Twojego serwera proxy API:
https://[host]/base_path/conditional_flow_path
Uwaga: ścieżka podstawowa musi być unikalna. Nie można wdrożyć 2 przekaźników interfejsu API z tą samą ścieżką podstawową. Jeśli edytujesz wdrożony interfejs API proxy i ustawiasz ścieżkę podstawową na taką samą jak ścieżka podstawowa innego interfejsu API proxy, Edge automatycznie wycofuje ten interfejs API proxy, gdy go zapiszesz. Zanim ponownie wdrożysz serwer proxy interfejsu API, musisz zmienić ścieżkę podstawową, aby była unikalna.
Używanie symboli wieloznacznych w ścieżkach bazowych
Użyj co najmniej 1 symbolu zastępczego
/*/
w ścieżkach podstawowych serwerów proxy interfejsu API, aby zapewnić ich zgodność z przyszłością. Na przykład ścieżka podstawowa/team/*/members
umożliwia klientom wywoływanie adresówhttps://[host]/team/blue/members
ihttps://[host]/team/green/members
bez konieczności tworzenia nowych serwerów proxy interfejsu API na potrzeby nowych zespołów. Uwaga:/**/
nie jest obsługiwany.Opis Krótki opis serwera proxy. - Kliknij Dalej.
- Na stronie WSDL wybierz typ serwera proxy interfejsu API REST na SOAP na REST.
Pojawi się tabela z wykazaniem operacji, które Edge „odkrył” w pliku WSDL. Możesz wybrać i skonfigurować operacje, które chcesz uwzględnić w proxy API. Tabela jest przedstawiona na rysunku poniżej.
- W kolumnie Typ portu wybierz zestaw operacji, których chcesz użyć. W WSDL elementy typu port określają operacje, które możesz wywoływać w usłudze internetowej.
- Opcjonalnie zmień metodę HTTP powiązaną z operacją.
Uwaga: przeglądarka Edge wybiera „najbardziej prawdopodobną” metodę HTTP do użycia w przypadku każdej operacji. Zazwyczaj zalecamy żądanie GET, ponieważ można je przechowywać w pamięci podręcznej.
- Opcjonalnie zmień ścieżkę interfejsu API REST dla operacji. Ścieżka będzie używana jako nazwa zasobu w adresie URL serwera proxy interfejsu API.
- Przejdź przez pozostałe kroki kreatora, aby dodać zabezpieczenia, wybrać hosty wirtualnych i środowisko wdrożenia.
- Na stronie Kompilacja kliknij Kompiluj i wdróż. Edge generuje i wdraża nowe proxy interfejsu API na podstawie pliku WSDL.
- Otwórz stronę podsumowania nowego serwera proxy interfejsu API. Pamiętaj, że na podstawie operacji odkrytych w pliku WSDL utworzono zestaw zasobów.
Na stronie przeglądu serwera proxy znajduje się lista Zasoby, która zawiera szczegółowy opis nowego interfejsu API, jego operacji i parametrów. Możesz traktować tę reprezentację jako dokumentację referencyjną interfejsu API. Edge automatycznie generuje ten widok modelu interfejsu API. Wystarczy rozwinąć zasób, aby zobaczyć jego opis i informacje o ścieżce.
Informacje o tym, jak działa serwer proxy
Gdy Edge generuje serwer proxy interfejsu API na podstawie pliku WSDL, generowany serwer proxy jest w istocie złożonym przepływem, który obejmuje zasady transformacji danych, wyodrębniania i ustawiania zmiennych oraz manipulowania wiadomościami. Po wygenerowaniu serwera proxy na podstawie pliku WSDL możesz sprawdzić wynikowy przepływ danych w widoku „Tworzenie” w interfejsie zarządzania interfejsem API. Tam możesz sprawdzić, które zasady zostały dodane.
Na przykład po stronie żądania do ustawienia docelowego adresu URL używa się zasady przypisywania wiadomości. Po stronie odpowiedzi zasady wykonują przekształcenie odpowiedzi z formatu XML na JSON, wyodrębniają część treści odpowiedzi SOAP i przekazują ją do zmiennej, a następnie ustawiają wiadomość odpowiedzi. Te zasady (oraz inne) są dodawane automatycznie podczas tworzenia serwera proxy.
Specyfikacja OpenAPI: aby wyświetlić automatycznie wygenerowaną specyfikację OpenAPI dla tego serwera proxy, otwórz stronę http(s)://[proxy_domain]/[proxy_base_path]/openapi.json
. Konwersja nie zawsze jest jednak dokładna, ponieważ nie wszystkie reguły schematu XML mogą być reprezentowane w specyfikacji OpenAPI.
Tworzenie serwera proxy przekazującego do usługi opartej na protokole SOAP
Z tej sekcji dowiesz się, jak utworzyć serwer proxy typu pass-through, korzystając z opcji Serwer proxy typu pass-through w oknie tworzenia nowego serwera proxy.
Omówienie
Opcja serwera proxy przekazującego umożliwia tworzenie serwera proxy, który przekazuje wiadomość SOAP w żądaniu do usługi backendu „bez zmian”. Dzięki temu możesz łatwo tworzyć serwery proxy dla usług internetowych opartych na protokole SOAP. W tle Edge automatycznie obsługuje wszystkie przekształcenia i inne czynności związane z przepływem danych. Jeśli na przykład żądanie jest w formacie JSON, Edge przekształca je w prawidłowe wiadomość SOAP XML z poprawnymi przestrzeniami nazw, zanim prześle ją do usługi. Podobnie, gdy usługa zwraca odpowiedź SOAP w formacie XML, Edge tłumaczy ją z powrotem na JSON, zanim przekaże ją klientowi. Oprócz tego Edge konfiguruje docelowy punkt końcowy zaplecza, który może się różnić w zależności od operacji SOAP.
W przypadku tego typu serwera proxy Edge hostuje plik WSDL i tworzy w nim przepływ, aby umożliwić Ci do niego dostęp. Adres WSDL hostowany w Edge (http(s)://[proxy_domain]/[proxy_base_path]?wsdl
) staje się nowym adresem URL punktu końcowego usługi dla klientów wywołujących usługę SOAP za pomocą serwera proxy.
Podstawowe czynności
Edge
Aby utworzyć serwer proxy przekazujący do usługi opartej na protokole SOAP za pomocą interfejsu Edge:
- Zaloguj się na stronie apigee.com/edge.
- Na pasku nawigacyjnym po lewej stronie kliknij Rozwijaj > Proxy interfejsu API.
- Kliknij +Proxy.
- Kliknij Usługa SOAP.
- Na stronie Szczegóły serwera proxy podaj informacje WSDL.
- Kliknij Dalej.
- Na stronie kreatora Wspólne zasady skonfiguruj te ustawienia:
- Wymagania dotyczące autoryzacji zabezpieczeń. Zobacz Dodawanie zabezpieczeń.
- Obsługa współdzielenia zasobów pomiędzy serwerami z różnych domen (CORS). Zobacz Dodawanie obsługi CORS.
- Limity, które chronią usługę backendową przed dużym natężeniem ruchu. Zobacz artykuł Limity. (niedostępne, jeśli wybrana jest autoryzacja typu pass-through)
- Egzekwowanie limitu zarabiania w przypadku organizacji, które mają włączone zarabianie. Zobacz artykuł Wymuszanie limitów zarabiania na serwerach proxy API.
- Na stronie WSDL wybierz typ proxy interfejsu API Przekazywanie dalej SOAP.
- W menu wybierz Typ portu, aby określić, którego zestawu operacji chcesz użyć. W WSDL elementy typu port określają operacje, które możesz wywoływać w usłudze internetowej.
- Kliknij Dalej.
- Na stronie kreatora Hosty wirtualnych wybierz hosty wirtualnych, z którymi serwer proxy API będzie powiązany po wdrożeniu. Więcej informacji znajdziesz w artykule Informacje o hostach wirtualnych.
- Wybierz środowisko(-a) wdrażania i kliknij Utwórz i wdróż
Nowe proxy interfejsu API zostanie utworzone i wdrożone w wybranym środowisku. - Kliknij Edytuj proxy, aby wyświetlić stronę szczegółów proxy API.
Classic Edge (Private Cloud)
Aby utworzyć serwer proxy przekazujący do usługi opartej na protokole SOAP za pomocą interfejsu klasycznej przeglądarki Edge:
- Zaloguj się na stronie
http://ms-ip:9000
, gdzie ms-ip to adres IP lub nazwa DNS węzła serwera zarządzania. - Na górnym pasku nawigacyjnym kliknij Interfejsy API > Proxy interfejsów API.
- Kliknij + Serwer proxy interfejsu API.
- W kreatorze tworzenia usługi proxy wybierz usługę SOAP.
- Kliknij Dalej.
- Na stronie Szczegóły wybierz: Po wybraniu pliku WSDL musisz kliknąć Weryfikuj.
W tym polu wykonaj to WSDL Wybierz źródło pliku WSDL.
- URL – wpisz adres URL WSDL, którego chcesz użyć.
- Plik – wybierz plik WSDL w systemie plików. W przypadku dodatkowych plików zależnych możesz zaznaczyć je wszystkie.
- Przykładowy adres URL – wybierz z listy plików WSDL publicznie dostępnych usług internetowych. Są one przydatne do testowania funkcji serwera proxy SOAP/API przeglądarki Edge.
Nazwa serwera proxy To nazwa tworzonego serwera proxy.
Ścieżka podstawowa proxy Ścieżka podstawowa serwera proxy to fragment URI, który jednoznacznie identyfikuje interfejs API udostępniany przez ten serwer proxy. Usługi API używają URI ścieżki podstawowej do dopasowywania i przekierowywania przychodzących wiadomości z żądaniami do odpowiedniego serwera proxy API. (Ścieżka podstawowa jest dołączana do domeny interfejsu API, która jest automatycznie generowana na podstawie nazwy organizacji i środowiska, w którym jest wdrożone uwierzytelnianie API). Sprawdzoną metodą jest dodawanie numeru wersji do nazwy projektu, np. /v1/delayedstockquote
. To określi sposób wywoływania interfejsu API przez aplikacje użytkowników.Uwaga: ścieżka podstawowa serwera proxy ma domyślnie wartość określoną w polu Nazwa serwera proxy, ale w przypadku, gdy nie zmienisz tej wartości, będzie ona miała postać wyłącznie małych liter.
Opis Krótki opis serwera proxy. - Kliknij Dalej.
- Na stronie WSDL wybierz typ proxy interfejsu API Przekazywanie dalej SOAP.
Uwaga: pojawi się tabela z każdą operacją WSDL i odpowiadającym jej ładunkiem SOAP. Jest to ładunek, który jest „przekazywany” do usługi SOAP w backendzie.
- W kolumnie Typ portu wybierz zestaw operacji, których chcesz użyć. W WSDL elementy typu port określają operacje, które możesz wywoływać w usłudze internetowej.
- Przejdź przez pozostałe kroki kreatora, aby dodać zabezpieczenia, wybrać hosty wirtualnych i środowisko wdrożenia.
- Na stronie Kompilacja kliknij Kompiluj i wdróż. Edge generuje i wdraża nowe proxy interfejsu API na podstawie pliku WSDL.
Informacje o tym, jak działa serwer proxy
Gdy Edge generuje serwer proxy przekazujące dalej, powstaje złożony proces, który obejmuje zasady dotyczące przetwarzania danych, wyodrębniania i ustawiania zmiennych oraz manipulowania wiadomościami. Po wygenerowaniu serwera proxy typu pass-through zapoznaj się z wynikiem w interfejsie zarządzania interfejsem API w widoku Develop. Możesz tam sprawdzić, które zasady zostały dodane.
Na przykład na rysunku poniżej widać część przepływu danych do docelowego punktu końcowego w przesyłce bezpośredniej przez serwer proxy. Po stronie żądania do ustawienia docelowego adresu URL służy zasada przypisywania wiadomości. Po stronie odpowiedzi zasady są wykonywane, aby przekształcić odpowiedź z formatu XML na JSON, wyodrębnić część treści SOAP odpowiedzi i ustawić wiadomość odpowiedzi. Te zasady (i inne) są dodawane automatycznie podczas tworzenia serwera proxy.
WSDL hostowany w Edge: aby wyświetlić WSDL hostowany w Edge wygenerowany dla tego typu serwera proxy, otwórz stronę http(s)://[proxy_domain]/[proxy_base_path]?wsdl
.
Zaawansowane tworzenie serwera proxy SOAP-to-REST
W poprzednich sekcjach omówiliśmy tworzenie serwera proxy interfejsu API SOAP-to-REST za pomocą kreatora serwera proxy interfejsu API w Edge. Jeśli jednak chcesz mieć większą kontrolę nad przekształcaniem SOAP w REST, możesz pominąć automatyzację zapewnianą przez kreatora i utworzyć serwer proxy, ręcznie dodając i konfigurując zasady, aby uzyskać pożądane działanie. Więcej informacji znajdziesz w artykule Samouczek: ręczne tworzenie przekierowania interfejsu API SOAP na interfejs API REST w usłudze Apigee Edge.