Références de variables dans API Connect

Types de variables

Méthodes de référencement des variables

Références GatewayScript

La politique GatewayScript n'est disponible qu'avec le " Premium subscription.

Si vous souhaitez référencer une variable dans un contexte GatewayScript, utilisez l'une des méthodes suivantes :

apim.getvariable(variable)

où variable est le nom de la variable contextuelle ou de la propriété d'API que vous souhaitez référencer.

apim.setvariable(variable, value, action)

où

• variable est le nom de la variable contextuelle ou de la propriété d'API que vous souhaitez référencer.
• value est la valeur de chaîne que vous voulez affecter à la variable. Il peut s'agir d'une valeur littérale ou d'une autre variable. Par exemple, pour définir la variable nommée sur la valeur de l'en-tête Content-Type dans une demande, utilisez le code suivant :

  var contentType = apim.getvariable('request.headers.content-type');
  apim.setvariable(variable, contentType, 'set');

  Cette propriété n'est requise que si l'action spécifiée est set ou add.
• action représente l'action à appliquer à la variable. Les options valides sont les suivantes :
  • set
  • add
  • clear
  Si aucune option n'est définie, l'option par défaut set est appliquée.

Utilisez la méthode getvariable pour extraire la valeur d'une variable contextuelle ou d'une propriété d'API et la méthode setvariable pour en modifier une.

Voici quelques cas dans lesquels vous utiliseriez ce type de référence :

• Stratégies GatewayScript . -Pour plus d'informations, voir GatewayScript.
• Constructions logiques if. Pour plus d'informations, voir si.

Références de feuille de style

La politique XSLT n'est disponible qu'avec le " Premium subscription.

Vous pouvez référencer une variable à l'aide de fonctions et d'éléments d'une stratégie XSLT avec la syntaxe suivante :

<xsl:variable name="variable_name" select="apim:getVariable(variable)" />

où variable est une valeur littérale, une autre variable ou une instruction XSLT XPath valide.

<xsl:call-template name="apim:setVariable"> 
    <xsl:with-param name="varName" select="variable"/>
    <xsl:with-param name="value" select="value"/>
    <xsl:with-param name="action" select="action"/>
</xsl:call-template> 

où

• variable est le nom de la variable contextuelle ou de la propriété d'API que vous souhaitez référencer. Il peut s'agir d'une valeur littérale, d'une autre variable ou d'une instruction XSLT XPath valide.
• value est la valeur de chaîne que vous voulez affecter à la variable. Il peut s'agir d'une valeur littérale, d'une autre variable ou d'une instruction XSLT XPath valide. Cette propriété n'est requise que si l'action spécifiée est set ou add.
• action représente l'action à appliquer à la variable. Il peut s'agir d'une valeur littérale, d'une autre variable ou d'une instruction XSLT XPath valide. Les options valides sont les suivantes :
  • set
  • add
  • clear
  Si aucune option n'est définie, l'option par défaut set est appliquée.

L'exemple suivant définit une variable nommée sur la valeur de l'en-tête Content-Type dans une demande :

<xsl:variable name="contentType" select="apim:getVariable('request.headers.content-type')" />
<xsl:call-template name="apim:setVariable"> 
    <xsl:with-param name="varName" select="'variable'"/>
    <xsl:with-param name="value" select="$contentType"/>
    <xsl:with-param name="action" select="'set'"/>
</xsl:call-template>

Références en ligne

Dans de nombreux cas, vous pouvez créer une référence plus simple, à l'aide de la syntaxe suivante :

$(variable)

où variable est le nom de la variable contextuelle ou de la propriété d'API que vous souhaitez référencer.

Voici quelques cas dans lesquels vous utiliseriez ce type de référence :

• Le site URL est appelé par une politique Invoke ou Proxy. Pour plus d'informations sur les stratégies, voir Appeler ou Proxy.
• Une stratégie Map . Pour plus d'informations, voir Carte.

Remarques: la stratégie map peut faire référence aux variables suivantes en ligne:

• Variables définies comme entrées de la stratégie de mappage et spécifiées dans la zone from d'un mappage.
• Variables contextuelles ou propriétés d'API à condition que la propriété d'API x-ibm-gateway-map-resolve-apic-variables ne soit pas définie sur false. Si une référence en ligne d'une stratégie de mappage est convertie en une variable contextuelle ou propriété d'API, elle est immédiatement remplacée par la valeur correspondante. Pour plus d'informations sur la propriété d'API x-ibm-gateway-map-resolve-apic-variables , voir Propriétés contrôlant la stratégie map.

Pour plus d'informations sur l'utilisation des références en ligne et des exemples, voir la section A propos des références en ligne .

A propos des références en ligne

curl --data-binary @request.json \
   -H 'Content-Type: application/json' \
   -H 'X-Environment: test' \
   http://apiserver/org/catalog/petstore/getPetDetails?petid=285&storeid=z03

 invoke:
    target-url: https://backend/GetPetInfo/$(request.parameters.storeid)/$(request.parameters.petid)

Vous pouvez également utiliser une référence en ligne dans la propriété condition d'une règle switch . Prenons l'exemple suivant :

- switch:
    case:
        - condition: "$(request.headers.X-Environment)" == "production"
            execute:
                - invoke:
                    http://www.finance.com/base/stockquote
        - condition: "$(request.headers.X-Environment)" == "test"
            execute:
                - invoke:
                    http://testserver1.finance.com/stockquote

condition: $(request.headers.X-Environment) == "production"

condition: $(request.headers.X-Environment) == "test"

- switch:
    case:
        - condition: request.headers["X-Environment"] == "production"
            execute:
                - invoke:
                    http://www.finance.com/base/stockquote
        - condition: request.headers["X-Environment"] == "test"
            execute:
                - invoke:
                    http://testserver1.finance.com/stockquote

- set-variable:
    actions:
        - set: saved.reqHdrs
           value: $(request.headers)
           type: string

- set-variable:
    actions:
        - set: saved.reqHdrs
           value: $(request.headers)
           type: any

$(request.body.property_name)

$(request.body.account-number)

$(request.body.account.balance)

$(message.body.property_name)