Establecer cuerpo

SE APLICA A: todos los niveles de API Management

Use la directiva set-body para establecer el cuerpo del mensaje para una solicitud o respuesta. Para acceder al cuerpo del mensaje, puede utilizar las propiedades context.Request.Body o context.Response.Body, según si la directiva se encuentra en la sección entrante o saliente.

Instrucción de la directiva

<set-body template="liquid" xsi-nil="blank | null" parse-date="true | false">
    new body value as text
</set-body>

Atributos

Para acceder a información sobre solicitud y respuesta, la plantilla Liquid puede enlazar a un objeto de contexto con las siguientes propiedades:

context.
    Request.
        Url
        Method
        OriginalMethod
        OriginalUrl
        IpAddress
        MatchedParameters
        HasBody
        ClientCertificates
        Headers

    Response.
        StatusCode
        Method
        Headers
Url.
    Scheme
    Host
    Port
    Path
    Query
    QueryString
    ToUri
    ToString

OriginalUrl.
    Scheme
    Host
    Port
    Path
    Query
    QueryString
    ToUri
    ToString

Uso

• Secciones de la directiva: entrante, saliente y back-end
• Ámbitos de la directiva: global, área de trabajo, producto, API, operación
• Puertas de enlace: clásica, v2, consumo, autohospedada y área de trabajo

Notas de uso

• Si usa la directiva set-body para devolver un cuerpo nuevo o actualizado, no hay que establecer preserveContent en true porque estará especificando explícitamente el nuevo contenido del cuerpo.
• No tiene sentido conservar el contenido de una respuesta en la canalización de entrada porque todavía no hay ninguna respuesta.
• De igual modo, no tiene sentido conservar el contenido de una solicitud en la canalización de salida porque la solicitud ya se ha enviado al servidor en este momento.
• Si esta directiva se usa cuando no haya ningún cuerpo de mensaje, por ejemplo, en un GET entrante, se producirá una excepción.

Para obtener más información, consulte las secciones context.Request.Body, context.Response.Body y IMessageBody de la tabla context.Request.Body (Variable de contexto).

Uso de plantillas Liquid con set-body

La directiva set-body se puede configurar para usar el lenguaje de plantillas set-body para transformar el cuerpo de una solicitud o una respuesta. Esto puede ser eficaz si tiene que cambiar completamente el formato del mensaje.

Filtros de Liquid admitidos

En la directiva set-body, se admiten los siguientes filtros de Liquid. Para ver ejemplos de filtros, consulte la documentación de Liquid.

• Abs
• Anexar
• AtLeast
• AtMost
• Capitalize
• Compacto
• Moneda
• Date
• Valor predeterminado
• DividedBy
• Downcase
• Escape
• First
• H
• Join
• Último
• Lstrip
• Asignación
• Resta
• Módulo
• NewlineToBr
• Plus
• Prepend
• Quitar
• RemoveFirst
• Replace
• ReplaceFirst
• Round
• Rstrip
• Size
• Segmento
• Sort
• Dividir
• Strip
• StripHtml
• StripNewlines
• Horas
• Truncate
• TruncateWords
• Uniq
• Upcase
• UrlDecode
• UrlEncode

Ejemplos

Texto literal

<set-body>Hello world!</set-body>

Acceso al cuerpo como una cadena

Estamos conservando el cuerpo de la solicitud original para que resulte accesible más adelante en la canalización.

<set-body>
@{ 
    string inBody = context.Request.Body.As<string>(preserveContent: true); 
    if (inBody[0] =='c') { 
        inBody[0] = 'm'; 
    } 
    return inBody; 
}
</set-body>

Acceso al cuerpo como un elemento JObject

Al no conservar el cuerpo de la solicitud original, el acceso posterior al mismo en la canalización producirá una excepción.

<set-body> 
@{ 
    JObject inBody = context.Request.Body.As<JObject>(); 
    if (inBody.attribute == <tag>) { 
        inBody[0] = 'm'; 
    } 
    return inBody.ToString(); 
} 
</set-body>

Filtro de respuesta según un producto

En este ejemplo se muestra cómo filtrar contenido quitando elementos de datos de la respuesta recibida del servicio back-end al usar el producto Starter. En la respuesta de back-end de ejemplo se incluyen propiedades de nivel raíz similares a One Call API de OpenWeather.

<!-- Copy this snippet into the outbound section to remove a number of data elements from the response received from the backend service based on the name of the product -->
<choose>
  <when condition="@(context.Response.StatusCode == 200 && context.Product.Name.Equals("Starter"))">
    <set-body>@{
        var response = context.Response.Body.As<JObject>();
        foreach (var key in new [] {"current", "minutely", "hourly", "daily", "alerts"}) {
          response.Property (key).Remove ();
        }
        return response.ToString();
      }
    </set-body>
  </when>
</choose>

Conversión de JSON en SOAP mediante una plantilla Liquid

<set-body template="liquid">
    <soap:Envelope xmlns="http://tempuri.org/" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
        <soap:Body>
            <GetOpenOrders>
                <cust>{{body.getOpenOrders.cust}}</cust>
            </GetOpenOrders>
        </soap:Body>
    </soap:Envelope>
</set-body>

Transformación de JSON mediante una plantilla Liquid

<set-body template="liquid">
{
"order": {
    "id": "{{body.customer.purchase.identifier}}",
    "summary": "{{body.customer.purchase.orderShortDesc}}"
    }
}
</set-body>

Acceso al cuerpo como datos de formulario con codificación de URL

En el ejemplo siguiente se usa la expresión AsFormUrlEncodedContent() para acceder al cuerpo de la solicitud como datos de formulario con codificación de URL (tipo application/x-www-form-urlencoded de contenido) y, después, se convierte en JSON. Al no conservar el cuerpo de la solicitud original, el acceso posterior al mismo en la canalización producirá una excepción.

<set-body> 
@{ 
    var inBody = context.Request.Body.AsFormUrlEncodedContent();
    return JsonConvert.SerializeObject(inBody); 
} 
</set-body>

Obtener acceso y devolver el cuerpo como datos de formulario codificados con URL

En el ejemplo siguiente se usa la expresión AsFormUrlEncodedContent() para tener acceso al cuerpo de la solicitud como datos de formulario con codificación URL (tipo de contenido application/x-www-form-urlencoded), se agregan datos a la carga y se devuelven datos de formulario con codificación URL. Al no conservar el cuerpo de la solicitud original, el acceso posterior al mismo en la canalización producirá una excepción.

<set-body> 
@{ 
    var body = context.Request.Body.AsFormUrlEncodedContent();
    body["newKey"].Add("newValue");
    return body.ToFormUrlEncodedContent(); 
} 
</set-body>

Directivas relacionadas

• Transformación

Contenido relacionado

Para más información sobre el trabajo con directivas, vea:

• Tutorial: Transformación y protección de una API
• Referencia de directivas para una lista completa de instrucciones de directivas y su configuración
• Expresiones de directiva
• Establecimiento o edición de directivas
• Reutilización de configuraciones de directivas
• Repositorio de fragmentos de código de directiva
• Creación de directivas mediante Microsoft Copilot en Azure