Retornar resposta

APLICA-SE A: todas as camadas do Gerenciamento de API

A política return-response cancela a execução do pipeline e retorna uma resposta padrão ou personalizada para o chamador. A resposta padrão é 200 OK sem corpo. A resposta personalizada pode ser especificada por meio de declarações de política ou variável de contexto. Quando ambas são fornecidas, a resposta contida na variável de contexto é modificada pelas instruções de política antes de ser retornada para o chamador.

Observação

Defina os elementos da política e os elementos filho na ordem fornecida na declaração da política. Saiba mais sobre como definir e editar as políticas de Gerenciamento de API.

Declaração de política

<return-response response-variable-name="existing context variable">
  <set-status>...</set-status>
  <set-header>...</set-header>
  <set-body>...</set-body>
</return-response>

Atributos

Atributo	Descrição	Obrigatório	Padrão
response-variable-name	O nome da variável de contexto referenciada de, por exemplo, uma política send-request upstream e contendo um objeto Response. Expressões de política não são permitidas.	Não	N/D

Elementos

Elemento	Descrição	Obrigatório
set-status	Define o código do status da resposta.	Não
set-header	Define um cabeçalho na resposta.	Não
set-body	Define o corpo na resposta.	Não

Uso

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

Observações de uso

• Um modelo líquido não funciona quando especificado dentro do corpo (definido usando set-body) da política return-response. A política return-response cancela o pipeline de execução atual e remove o corpo da solicitação e o corpo da resposta no contexto atual. Como resultado, um modelo líquido especificado dentro da política recebe uma cadeia de caracteres vazia como entrada e não produzirá a saída esperada.

Exemplo

<return-response>
   <set-status code="401" reason="Unauthorized"/>
   <set-header name="WWW-Authenticate" exists-action="override">
      <value>Bearer error="invalid_token"</value>
   </set-header>
</return-response>

Políticas relacionadas

• Transformação

Conteúdo relacionado

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

• Tutorial: Transformar e proteger sua API
• Referência de Política para uma lista completa das instruções de política e suas configurações
• Expressões de política
• Definir ou editar políticas
• Reutilizar configurações de política
• Repositório de snippets de política
• Criar políticas usando o Microsoft Copilot para Azure