Règle XSLTransform

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

icône de la règle

Quoi

La règle XSLTransform applique des Transformations de langage de feuille de style extensible (XSLT) personnalisées aux messages XML, ce qui vous permet de les convertir de XML à un autre format, tel que HTML ou texte brut. Elle est souvent utilisée pour intégrer des applications compatibles avec XML, mais qui exigent des formats XML différents pour les mêmes données.

Cette règle est une règle extensible et son utilisation peut avoir des conséquences sur le coût ou l'utilisation, en fonction de votre licence Apigee. Pour en savoir plus sur les types de règles et les implications en termes d'utilisation, consultez la section Types de règles.

Entrées

La règle XSL utilise en entrée les paramètres suivants :

  • (Obligatoire) Nom d'une feuille de style XSLT qui contient un ensemble de règles de transformation stockées dans le proxy d'API sous /resources/xsl.
  • (Obligatoire) Fichier XML à transformer (généralement un message de requête ou de réponse).
  • (Facultatif) Nom d'une variable qui stocke le résultat en sortie.
  • (Facultatif) Paramètres correspondant aux paramètres de la feuille de style XSL.

Processeur d'analyse

Apigee s'appuie sur le processeur XSLT Saxon et est compatible avec XSLT 1.0 et 2.0.

Éléments XSL non compatibles

La règle XSL n'est pas compatible avec les éléments XSL suivants :

  • <xsl:include>
  • <xsl:import>

Exemples

Les exemples suivants illustrent un flux de transformation XSL :

Règle XSL -->

<XSL name="TransformXML">   <ResourceURL>xsl://my_transform.xsl</ResourceURL>   <Source>request</Source> </XSL>

Règle XSL simple. Passez à l'exemple suivant pour voir la feuille de style XSLT référencée dans la règle (my_transform.xsl). L'élément <Source> est important. Par exemple, si le fichier XML que vous souhaitez transformer est présent dans la réponse, la transformation ne se produira que si vous définissez <Source> sur response (et que la règle est associée au flux de réponse). Cependant, dans le cas présent, le XML à transformer se trouve dans la requête.

Feuille de style XSLT -->

<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">   <xsl:output method="text"/>   <xsl:variable name="newline">     <xsl:text></xsl:text>   </xsl:variable>   <xsl:template match="/">   <xsl:text>&lt;Life&gt;</xsl:text>     <xsl:value-of select="$newline"/>     <xsl:text>Here are the odd-numbered items from the list:</xsl:text>     <xsl:value-of select="$newline"/>     <xsl:for-each select="list/listitem">       <xsl:if test="(position() mod 2) = 1">         <xsl:number format="1. "/>         <xsl:value-of select="."/>         <xsl:value-of select="$newline"/>       </xsl:if>     </xsl:for-each>   <xsl:text>&lt;/Life&gt;</xsl:text> </xsl:template> </xsl:stylesheet>

Feuille de style my_transform.xsl référencée dans la règle. Passez à l'exemple suivant pour voir un exemple de message XML entrant.

Message -->

<?xml version="1.0"?> <list>   <title>A few of my favorite albums</title>   <listitem>A Love Supreme</listitem>   <listitem>Beat Crazy</listitem>   <listitem>Here Come the Warm Jets</listitem>   <listitem>Kind of Blue</listitem>   <listitem>London Calling</listitem>   <listitem>Remain in Light</listitem>   <listitem>The Joshua Tree</listitem>   <listitem>The Indestructible Beat of Soweto</listitem> </list>

Exemple de message dans la requête (indiqué dans l'élément <Source>request</Source> de la règle dans le premier exemple).

Message transformé

<Life> Here are the odd-numbered items from the list: 1. A Love Supreme 3. Here Come the Warm Jets 5. London Calling 7. The Joshua Tree </Life>

Le message transformé d'après la feuille de style XSLT de ces échantillons est appliqué au message XML.

Élément <XSL>

Définit une règle XSLTransform.

Valeur par défaut N/A
Obligatoire ? Obligatoire
Type Objet complexe
Élément parent Non disponible
Éléments enfants <OutputVariable>
<Parameters>
<ResourceURL>
<Source>

L'élément <XSL> possède les attributs suivants :

Attribut Description Obligatoire ? Type
name Nom de la stratégie Les caractères que vous pouvez utiliser dans le nom se limitent à : A-Z0-9._\-$ %. L'interface utilisateur Apigee applique cependant des restrictions supplémentaires, telles que la suppression automatique des caractères qui ne sont pas alphanumériques. Obligatoire Chaîne

Référence d'élément enfant

Cette section décrit les éléments enfants de <XSL>.

<OutputVariable>

Variable qui stocke le résultat de la transformation. Vous devez définir cet élément en tant que variable personnalisée, puis utiliser cette variable.

Valeur par défaut N/A
Obligatoire ? Facultatif
Type Chaîne
Élément parent <XSL>
Éléments enfants Aucun

La valeur de <OutputVariable> ne peut pas être de type message ; autrement dit, ni message, request, ou response.

Pour remplacer le contenu du message par le résultat de la transformation, supprimez cet élément. Par exemple, si vous transformez un message en HTML, n'incluez pas cet élément.

<Parameters>

Ajout de la compatibilité avec l'élément <xsl:param> dans vos feuilles de style. Vous définissez chaque paramètre en tant qu'élément enfant <Parameter> de cet élément.

Valeur par défaut N/A
Obligatoire ? Facultatif
Type Tableau d'éléments <Parameter>
Élément parent <XSL>
Éléments enfants <Parameter>

L'élément <Parameters> possède les attributs suivants :

Attribut Description Obligatoire ? Type
ignoreUnresolvedVariables Détermine si la règle ignore les erreurs de variables non résolues dans les instructions de script XSLT. La valeur par défaut est false, ce qui signifie que, par défaut, la règle génère des erreurs si elle rencontre des variables non résolues. Facultatif Booléen

<Parameter>

Définit un paramètre dans l'élément <Parameters>.

Valeur par défaut N/A
Obligatoire ? Facultatif
Type Objet complexe
Élément parent <Parameters>
Éléments enfants Aucun

L'élément <Parameter> possède les attributs suivants :

Attribut Obligatoire ? Type Description
name Obligatoire Chaîne

Nom du paramètre. Apigee met en correspondance la valeur que vous définissez ici avec la valeur de l'attribut name sur un élément <xsl:param> dans la feuille de style.

Par exemple, si vous saisissez le nom uid, votre XSL peut ressembler à ceci : 

<xsl:param name="uid" select="''"/>
ref Facultatif Chaîne

Pointe vers une variable de contexte contenant la valeur du paramètre. Les valeurs des variables de contexte ref doivent être définies avant l'évaluation de cette règle.

Par exemple, si un paramètre uid doit obtenir sa valeur à partir d'une variable appelée authn.uid, l'élément <Parameter> ressemblerait à ceci :

<Parameter name="uid" ref="authn.uid"/>

Si vous utilisez cet attribut, n'utilisez pas l'attribut value.
value Facultatif Chaîne

Spécifie une valeur codée en dur pour le paramètre. Par exemple, si un paramètre nommé answer doit avoir la valeur 42, l'élément <Parameter> ressemblerait à ceci :

<Parameter name="answer" value="42"/>

Si vous utilisez cet attribut, n'utilisez pas l'attribut ref.

Le paramètre obtient sa valeur à partir de l'attribut ref ou à partir d'une valeur value explicite.

Pour obtenir un exemple et davantage d'informations, consultez la section Comment utiliser les paramètres facultatifs de la règle de transformation XSL ?

<ResourceURL>

Le fichier XSL qu'Apigee utilise pour transformer le message. La valeur de cet élément correspond au nom de la feuille de style XSL stockée dans le proxy d'API sous /resources/xsl.

Valeur par défaut N/A
Obligatoire ? Obligatoire
Type Chaîne
Élément parent <XSL>
Éléments enfants Aucun

Exemple :

<ResourceURL>xsl://SubscriberNumbers-Request.xsl</ResourceURL>

Pour en savoir plus, consultez la section Fichiers de ressources.

<Source>

Spécifie le message transformé. Cette valeur est généralement définie sur request ou response, selon que le message à transformer est entrant ou sortant.

Valeur par défaut N/A
Obligatoire ? Facultatif
Type Chaîne
Élément parent <XSL>
Éléments enfants Aucun

Le fichier XSL qui définit la transformation est défini par la <ResourceURL>.

  • Si la source est manquante, celui-ci est traité comme un message simple. Exemple : <Source>message</Source>
  • Si la variable source ne peut pas être résolue, ou si elle est résolue en un type qui n'est pas un message, l'étape de transformation échoue.

Informations de référence sur les erreurs

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix
steps.xsl.XSLSourceMessageNotAvailable 500 This error occurs if the message or string variable specified in the <Source> element of the XSLTransform policy is either out of scope (not available in the specific flow where the policy is being executed) or can't be resolved (is not defined).
steps.xsl.XSLEvaluationFailed 500 This error occurs if the input XML payload is unavailable/malformed or the XSLTransform policy fails/is unable to transform the input XML file based on the transformation rules provided in the XSL file. There could be many different causes for the XSLTransform policy to fail. The reason for failure in the error message will provide more information on the cause.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Cause Fix
XSLEmptyResourceUrl If the <ResourceURL> element in the XSLTransform policy is empty, then the deployment of the API proxy fails.
XSLInvalidResourceType If the resource type specified in the <ResourceURL> element of the XSLTransform policy is not of type xsl, then the deployment of the API proxy fails.

Articles associés