Referencias de variable en API Connect

Tipos de variable

Métodos de referenciación de variables

Referencias de GatewayScript

La política GatewayScript sólo está disponible con el " Premium subscription.

Cuando desee hacer referencia a una variable en un contexto de GatewayScript, utilice uno de los métodos siguientes:

apim.getvariable(variable)

donde variable es el nombre de la variable de contexto o la propiedad de API a la que desea hacer referencia.

apim.setvariable(variable, value, action)

donde

• variable es el nombre de la variable de contexto o la propiedad de API a la que desea hacer referencia.
• valor es el valor de la serie en el que desea establecer la variable. Puede tratarse de un valor literal u otra variable. Por ejemplo, para establecer la variable con nombre en el valor de la cabecera Content-Type de una solicitud, utilice el código siguiente:

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

  Esta propiedad sólo es necesaria cuando se especifica set o add como acción.
• action es la acción que desea aplicar a la variable. Las opciones válidas son:
  • set
  • add
  • clear
  Si no se establece ninguna opción, se aplica la opción predeterminada set.

Utilice el método getvariable para recuperar el valor de una variable de contexto o una propiedad de API y el método setvariable para cambiar uno.

Algunas de las situaciones en las que puede utilizar este tipo de referencia son las siguientes:

• GatewayScript . -Para obtener más información, consulte GatewayScript.
• Construcciones lógicas de if . Para obtener más información, consulte if.

Referencias de hoja de estilo

La política XSLT sólo está disponible con el ' Premium subscription.

Puede hacer referencia a una variable utilizando funciones y elementos en una política XSLT con la sintaxis siguiente:

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

donde variable es un valor de literal, otra variable o una sentencia XSLT XPath.

<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> 

donde

• variable es el nombre de la variable de contexto o la propiedad de API a la que desea hacer referencia. Puede ser un valor de literal, otra variable o una sentencia XSLT XPath válida.
• valor es el valor de la serie en el que desea establecer la variable. Puede ser un valor de literal, otra variable o una sentencia XSLT XPath válida. Esta propiedad sólo es necesaria cuando se especifica set o add como acción.
• action es la acción que desea aplicar a la variable. Puede ser un valor de literal, otra variable o una sentencia XSLT XPath válida. Las opciones válidas son:
  • set
  • add
  • clear
  Si no se establece ninguna opción, se aplica la opción predeterminada set.

En el ejemplo siguiente se establece una variable con nombre en el valor de la cabecera Content-Type en una solicitud:

<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>

Referencias en línea

En muchas situaciones puede hacer una referencia más simple mediante la sintaxis siguiente:

$(variable)

donde variable es el nombre de la variable de contexto o la propiedad de API a la que desea hacer referencia.

Algunas de las situaciones en las que puede utilizar este tipo de referencia son las siguientes:

• El URL es llamado por una política Invoke o Proxy. Para obtener más información sobre las políticas, consulte Invocar o Proxy.
• Una política Map . Para obtener más información, consulte Mapa.

Notas: La política de correlación puede hacer referencia a las variables siguientes en línea:

• Variables definidas como entradas de la política de correlación y especificadas en el campo from de una correlación.
• Variable de contexto o propiedades de API, siempre que la propiedad de API x-ibm-gateway-map-resolve-apic-variables no esté establecida en false. Si una referencia en línea de una política de correlación se resuelve en una variable de contexto o una propiedad de API, se sustituye inmediatamente por el valor correspondiente. Para obtener más información sobre la propiedad de API x-ibm-gateway-map-resolve-apic-variables , consulte Propiedades que controlan la política de correlación.

Para obtener más información sobre el uso de referencias en línea y ejemplos, consulte la siguiente sección Acerca de las referencias en línea .

Acerca de las referencias en línea

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)

También puede utilizar una referencia en línea en la propiedad condition de una política switch . Consulte el ejemplo siguiente:

- 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)