Przeglądasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. Informacje
Jeśli po raz pierwszy testujesz objaśnienia w Javie, najlepiej dowiedz się, jak utworzyć objaśnienie w Javie.
Ten przykład książki kucharskiej pokazuje, jak utworzyć prostą zasadę JavaCallout, która uruchamia niestandardowy kod Java w kontekście przepływu serwera proxy.
Do czego służy przykładowy kod?
Serwer proxy interfejsu API w tym przykładzie wywołuje usługę docelową, która zwraca prostą odpowiedź JSON. Zasada dotycząca objaśnień w Javie jest umieszczona w docelowym przepływie odpowiedzi. Kod Java konwertuje nagłówki i treść odpowiedzi na wielkie litery. Jest to prosty przykład, ale obrazuje, jak uzyskać niestandardowy kod w Javie w kontekście serwera proxy interfejsu API w Edge.
Skorzystaj z przykładu
Pobierz projekt
Dla uproszczenia możesz pobrać ten projekt z repozytorium Apigee api-platform-samples na GitHubie.
- Pobierz lub skopiuj parametr api-platform-samples do swojego systemu.
- W wybranym terminalu lub edytorze kodu otwórz projekt
api-platform-samples/doc-samples/java-cookbook
.
Kompilowanie kodu za pomocą narzędzia Maven
Projekt jest skonfigurowany tak, aby można było skompilować projekt w narzędziu Maven. Jeśli chcesz użyć właściwości javac
, podamy zarówno przykład, jak i przykład z narzędzia Maven.
- Sprawdź, czy masz zainstalowane narzędzie Maven:
mvn -version
- Uruchom skrypt
java-cookbook/buildsetup.sh
. Ten skrypt instaluje wymagane zależności JAR w lokalnym repozytorium Maven. - cd do katalogu
java-cookbool/callout
. - Wykonaj Maven:
mvn clean package
- Jeśli chcesz, sprawdź, czy plik JAR
edge-custom-policy-java-cookbook.jar
został skopiowany dojava-cookbook/apiproxy/resources/java
. To jest wymagana lokalizacja plików JAR, które chcesz wdrożyć za pomocą serwera proxy.
Kompilacja za pomocą języka javac
Jeśli chcesz skompilować kod za pomocą polecenia javac
, możesz zrobić to w podobny sposób (z katalogu java-cookbook
). Wymagane pliki JAR znajdziesz w katalogu java-cookbook/lib
.
- CD na
api-platform-samples/doc-samples/java-cookbook
. - Upewnij się, że w ścieżce jest plik javac.
javac -version
- Wykonaj to polecenie javac:
javac -d . -classpath ./lib/expressions-1.0.0.jar:./lib/message-flow-1.0.0.jar:. callout/src/main/java/ResponseUppercase.java
- Skopiuj plik JAR do katalogu apiproxy/resources/java. To jest wymagana lokalizacja plików JAR, które chcesz wdrożyć za pomocą serwera proxy.
cp com/apigeesample/ResponseUppercase.class apiproxy/resources/java
Wdrażanie i wywoływanie serwera proxy
Skrypt wdrażania znajduje się w katalogu ./java-cookbook
. Ale zanim ją uruchomisz, musisz ją szybko skonfigurować.
- cd do
api-platform-samples/doc-samples/java-cookbook
- Otwórz plik
../../setup/setenv.sh
i edytuj go zgodnie z informacjami o Twoim koncie Apigee: nazwą użytkownika (adresem e-mail powiązanym z kontem), nazwą organizacji i domeną, której używasz do wykonywania wywołań zarządzania przez interfejs API. Na przykład w przypadku Edge Cloud domena tohttps://api.enterprise.apigee.com
, ale Twoja domena może być inna, jeśli używasz Edge Private Cloud. - Zapisz plik
setenv.sh
. - Uruchom skrypt wdrożenia:
./deploy.sh
- Jeśli wdrożenie się powiedzie, wykonaj skrypt wywoływania:
./invoke.sh
Skrypt wywołania wywołuje polecenie cURL, które wygląda tak:
curl http://$org-$env.$api_domain/java-cookbook/json
Odpowiedź wygląda mniej więcej tak:
< HTTP/1.1 200 OK < Date: Tue, 09 May 2017 20:31:08 GMT < Content-Type: APPLICATION/JSON; CHARSET=UTF-8 < Content-Length: 68 < Connection: keep-alive < Access-Control-Allow-Origin: * < ETag: W/"44-RA5ERT/MMLIK54NVBWBSZG" < X-Powered-By: APIGEE < Server: Apigee Router < * Curl_http_done: called premature == 0 * Connection #0 to host willwitman-test.apigee.net left intact {"FIRSTNAME":"JOHN","LASTNAME":"DOE","CITY":"SAN JOSE","STATE":"CA"}
Przepływ serwera proxy
To jest ujęcie narzędzia do śledzenia pokazujące przepływ serwera proxy:
Struktura serwera proxy
To jest struktura serwera proxy. Pamiętaj, że w katalogu apiproxy/resources/java
znajduje się plik JAR. Plik JAR jest wymagany. Udostępniamy go na potrzeby przykładu, ale jeśli wykonujesz zadania niestandardowe, musisz utworzyć go samodzielnie i skopiować do tego miejsca. Wskazówki dotyczące kompilowania i wdrażania objaśnienia w Javie znajdziesz w artykule Jak utworzyć objaśnienie w Javie.
java-cookbook apiproxy java-cookbook.xml policies responseUppercase.xml proxies default.xml resources java ResponseUppercase.jar targets default.xml
Informacje o kodzie Java
Zasada objaśnień w Javie uruchamia poniższy kod w Javie, który konwertuje nagłówki i treść odpowiedzi na wielkie litery. Zwróć uwagę, że program używa pakietów specyficznych dla Apigee. Pakiety te udostępniają obiekty i metody, których możesz używać do bezpośredniej interakcji z procesem serwera proxy. Istnieją metody umożliwiające pobieranie i ustawianie zmiennych przepływu, nagłówków, treści wiadomości itp.
package com.apigeesample; import com.apigee.flow.execution.ExecutionContext; import com.apigee.flow.execution.ExecutionResult; import com.apigee.flow.execution.spi.Execution; import com.apigee.flow.message.MessageContext; import java.util.Set; public class ResponseUppercase implements Execution{ public ExecutionResult execute(MessageContext messageContext, ExecutionContext executionContext) { try { Set headers = messageContext.getMessage().getHeaderNames(); for (String header : headers) { String h = messageContext.getMessage().getHeader(header).toUpperCase(); messageContext.getMessage().setHeader(header, h); } String content = messageContext.getMessage().getContent(); messageContext.getMessage().setContent(content.toUpperCase()); return ExecutionResult.SUCCESS; } catch (Exception e) { return ExecutionResult.ABORT; } } }
Sprawdź przykładowy serwer proxy
Możesz otworzyć serwer proxy i sprawdzić pliki. Oto zasady dotyczące objaśnień Java. Zwróć uwagę, jak odwołuje się do klasy wykonywanej przez wywołanie i pliku JAR. Wszystkie zasady dotyczące objaśnień w Javie są zgodne z tym wzorcem. Zapoznaj się też z zasadami dotyczącymi objaśnień w języku Java.
<JavaCallout name="responseUppercase"> <ClassName>com.apigeesample.ResponseUppercase</ClassName> <ResourceURL>java://ResponseUppercase.jar</ResourceURL> </JavaCallout>