Definir corpo

APLICA-SE A: Todas as camadas de gerenciamento de API

Use a set-body política para definir o corpo da mensagem para uma solicitação ou resposta. Para acessar o corpo da mensagem, você pode usar a context.Request.Body propriedade ou o context.Response.Body, dependendo se a política está na seção de entrada ou saída.

Declaração de política

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

Atributos

Para acessar informações sobre a solicitação e a resposta, o modelo Liquid pode ser vinculado a um objeto de contexto com as seguintes propriedades:

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

Utilização

• Seções de política: entrada, saída, back-end
• Âmbitos de política: global, área de trabalho, produto, API, operação
• Gateways: clássico, v2, consumo, auto-hospedado, espaço de trabalho

Notas de utilização

• Se você estiver usando a set-body política para retornar um corpo novo ou atualizado, não precisará definir preserveContent como true porque está fornecendo explicitamente o novo conteúdo do corpo.
• Preservar o conteúdo de uma resposta no pipeline de entrada não faz sentido porque ainda não há resposta.
• Preservar o conteúdo de uma solicitação no pipeline de saída não faz sentido porque a solicitação já foi enviada para o back-end neste momento.
• Se essa política for usada quando não houver corpo de mensagem, por exemplo, em uma entrada GET, uma exceção será lançada.

Para obter mais informações, consulte o context.Request.Body, context.Response.Bodye as seções na tabela Variável de IMessageBodycontexto.

Usando modelos Liquid com set-body

A set-body política pode ser configurada para usar a linguagem de modelos Liquid para transformar o corpo de uma solicitação ou resposta. Isso pode ser eficaz se você precisar remodelar completamente o formato da sua mensagem.

Filtros de líquidos suportados

Os seguintes filtros de líquido são suportados set-body na política. Para obter exemplos de filtros, consulte a documentação de Líquidos.

• Abdominais
• Acrescentar
• Pelo menos
• No máximo
• Capitalizar
• Compacto
• Moeda
• Data
• Predefinição
• Divididopor:
• Caixa baixa
• Esc
• Primeiro
• H
• Participar
• Último
• Lstrip
• Mapa
• Menos
• Módulo
• NewlineToBr
• Sinal de adição
• Pendente
• Remover
• RemoveFirst
• Substituir
• SubstituirPrimeiro
• Rodada
• Rstrip
• Tamanho
• Setor
• Ordenar
• Dividida
• Tira
• StripHtml
• StripNewlines
• Horas
• Truncar
• TruncateWords
• Uniq
• Caixa de reposição
• Decodificação de URL
• Codificação de URL

Exemplos

Texto literal

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

Acessando o corpo como uma cadeia de caracteres

Estamos preservando o corpo de solicitação original para que possamos acessá-lo mais tarde no pipeline.

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

Acessando o corpo como um JObject

Como não estamos reservando o corpo de solicitação original, acessá-lo mais tarde no pipeline resultará em uma exceção.

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

Filtrar a resposta com base no produto

Este exemplo mostra como executar a filtragem de conteúdo removendo elementos de dados da resposta recebida de um serviço de back-end ao usar o Starter produto. O exemplo de resposta de back-end inclui propriedades de nível raiz semelhantes à API de chamada do OpenWeather One.

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

Converter JSON em SOAP usando um modelo 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>

Transformar JSON usando um modelo Liquid

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

Acessar o corpo como dados de formulário codificados por URL

O exemplo a seguir usa a AsFormUrlEncodedContent() expressão para acessar o corpo da solicitação como dados de formulário codificados por URL (tipo application/x-www-form-urlencodedde conteúdo) e, em seguida, converte-a em JSON. Como não estamos reservando o corpo de solicitação original, acessá-lo mais tarde no pipeline resultará em uma exceção.

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

Acessar e retornar o corpo como dados de formulário codificados por URL

O exemplo a seguir usa a AsFormUrlEncodedContent() expressão para acessar o corpo da solicitação como dados de formulário codificados por URL (tipo application/x-www-form-urlencodedde conteúdo), adiciona dados à carga útil e retorna dados de formulário codificados por URL. Como não estamos reservando o corpo de solicitação original, acessá-lo mais tarde no pipeline resultará em uma exceção.

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

Políticas relacionadas

• Transformação

Conteúdos relacionados

Para obter mais informações sobre como trabalhar com políticas, consulte:

• Tutorial: Transforme e proteja sua API
• Referência de política para uma lista completa de declarações de política e suas configurações
• Expressões de política
• Definir ou editar políticas
• Reutilizar configurações de política
• Recompra de trechos de política
• Política de recompra de parques infantis
• Kit de ferramentas de política de Gerenciamento de API do Azure
• Obtenha assistência do Copilot para criar, explicar e resolver problemas com políticas