Uzyskiwanie dostępu do zmiennych przepływu w Node.js

Wyświetlasz dokumentację Apigee Edge.
Przejdź do dokumentacji Apigee X. info

Wprowadzenie

Użyj modułu apigee-access, aby uzyskać dostęp do zmiennych przepływu Apigee Edge w aplikacji Node.js. Moduł ma metody pobierania, ustawiania i usuwania zmiennych. Ma też wygodną metodę dla ustawiania zmiennej całkowitej.

Zmienne przepływu istnieją w kontekście przepływu proxy interfejsu API. Niektóre zmienne są "wbudowane" w Edge. Inne są tworzone podczas wykonywania zasad, a Ty możesz tworzyć własne zmienne. Zmienne przepływu są zwykle używane do przekazywania danych z jednej zasady do drugiej oraz do ustawiania warunków w przepływach warunkowych. Więcej informacji o zmiennych przepływu znajdziesz w artykule Zmienne przepływu i warunki.

Więcej informacji o module apigee-access i jego innych funkcjach znajdziesz w artykule Korzystanie z modułu apigee-access.

Działający przykład

Załóżmy, że zasada Edge działająca w ścieżce przepływu żądania ustawia zmienną o nazwie AuthenticatedUserId. Poniższy kod uzyskuje dostęp do tej zmiennej i zapisuje ją w logu. Dodatkowo ten kod ustawia zmienną. Następnie możesz uzyskać dostęp do tej zmiennej z zasady, co pokazujemy poniżej.

var http = require('http');
var apigee = require('apigee-access');

http.createServer(function (request, response) {
  // The request parameter must be a request object that came from the http module
  var userId = apigee.getVariable(request, 'AuthenticatedUserId');
  apigee.setVariable(request, "custom.foo", "Bar");
  console.log('Authenticated Apigee User ID is %s', userId);
  response.writeHead(200, {'Content-Type': 'text/plain'});
  response.end('Hello World\n');
}).listen(8124);

console.log('Server running at http://127.0.0.1:8124/');

Możesz skopiować ten kod do pliku JavaScript, wdrożyć go w Edge i wypróbować. Nazwij plik server.js. Aby go wdrożyć, użyj tego polecenia:

apigeetool deploynodeapp -u username -p password -o myorg -e test -n access -d . -m server.js -b /access

Po wdrożeniu aplikacji w Edge dodaj zasadę AssignMessage z tą konfiguracją do przepływu żądania ProxyEndpoint:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="AddUserId">
    <DisplayName>AddUserId</DisplayName>
    <FaultRules/>
    <Properties/>  
    <AssignVariable>
        <Name>AuthenticatedUserId</Name>
        <Value>ntesla</Value>
        <Ref/>
    </AssignVariable>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Następnie dołącz inną zasadę AssignMessage do przepływu wstępnego odpowiedzi TargetEndpoint:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="SetHeader">
    <DisplayName>SetHeader</DisplayName>
    <FaultRules/>
    <Properties/>
    <Set>
        <Headers>
            <Header name="MySpecialHeader">{custom.foo}</Header>
        </Headers>
    </Set>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Możesz wywołać serwer proxy w ten sposób:

curl -i http://myorg-test.apigee.net/access

Teraz otwórz stronę serwera proxy dostępu w interfejsie zarządzania i wyświetl widok Programowanie. Kliknij Logi Node.js, aby wyświetlić dane wyjściowe logów z serwera proxy. Jeśli serwer proxy jest prawidłowo skonfigurowany, zobaczysz, że zmienna userId została ustawiona. Zobaczysz też, że nagłówek został ustawiony w danych wyjściowych cURL w oknie terminala:

HTTP/1.1 200 OK

Content-Type: text/plain
Date: Tue, 27 05 2014 23:20:52 GMT
MySpecialHeader: Bar
Content-Length: 12
Connection: keep-alive

Metody

getVariable

var result = getVariable(httpRequest, name);

Pobiera zmienną o podanej nazwie.

Parametry:

  • httpRequest: obiekt żądania pochodzący z modułu http.
  • name: (ciąg znaków) nazwa zmiennej do pobrania.

Zwraca:

Ciąg znaków lub liczbę, w zależności od typu ustawionego za pomocą setVariable(), gdy został utworzony przez Ciebie w innym miejscu lub gdy utworzyła go zasada. Jeśli uzyskujesz dostęp do jednej z gotowych zmiennych Edge, listę typów znajdziesz w dokumentacji zmiennych. W przypadku typów zmiennych utworzonych przez zasady zapoznaj się z odpowiednim tematem w dokumentacji zasad.

Przykłady:

var apigee = require('apigee-access');
    // "httpRequest" must be a request object that came from the http module
    var val1 = apigee.getVariable(request, 'TestVariable');
    var val2 = apigee.getVariable(request, 'request.client.ip');

setVariable

setVariable(httpRequest, name, value);

Ustawia zmienną. Niektóre zmienne są tylko do odczytu, a metoda setVariable() zgłasza an wyjątek, jeśli spróbujesz ustawić jedną z nich. Aby sprawdzić, które zmienne są tylko do odczytu, zapoznaj się z dokumentacją zmiennych .

Parametry:

  • httpRequest: obiekt żądania pochodzący z modułu http.
  • name: (ciąg znaków) nazwa zmiennej do pobrania.
  • value: może być liczbą, ciągiem znaków, wartością logiczną, wartością null lub wartością undefined.

Przykład:

var apigee = require('apigee-access');
    apigee.setVariable(request, 'TestVariable', 'bar');
    // This will throw an exception because client.ip is read-only.
    apigee.setVariable(request, 'client.ip');

setIntVariable

setIntVariable(httpRequest, name, value);

Metoda setIntVariable() to wygodna metoda, która najpierw przekształca parametr value na liczbę całkowitą, a następnie ją ustawia.

Parametry:

  • httpRequest: obiekt żądania pochodzący z modułu http.
  • name: (ciąg znaków) nazwa zmiennej do ustawienia.
  • value: parametr value musi być ciągiem znaków lub liczbą.

Przykład:

var apigee = require('apigee-access');
// Convert "123" to an integer and set it
apigee.setIntVariable(request, 'TestVariable', '123');
// Use something that's already a number
apigee.setIntVariable(request, 'TestVariable2', 42);

deleteVariable

Usuwa zmienną o podanej nazwie. Usunięcie zmiennej tylko do odczytu jest błędem. Pełną listę zmiennych tylko do odczytu znajdziesz w dokumentacji zmiennych.

deleteVariable(httpRequest, name);

Parametry:

  • httpRequest: obiekt żądania pochodzący z modułu http.
  • name: (ciąg znaków) nazwa zmiennej do usunięcia.

Przykład:

  apigee.deleteVariable(request, 'TestVariable');
    // This will throw an exception because client.ip is a read-only variable.
    apigee.deleteVariable(request, 'client.ip');