Devolución de respuesta

SE APLICA A: todos los niveles de API Management

La directiva return-response cancela la ejecución de la canalización y devuelve una respuesta personalizada o predeterminada al autor de la llamada. La respuesta predeterminada es 200 OK sin cuerpo. La respuesta personalizada se puede especificar mediante declaraciones de directiva o variable de contexto. Cuando se especifican ambas, las declaraciones de la directiva modifican la respuesta que se encuentra en la variable de contexto antes de devolverla al autor de la llamada.

Nota

Establezca los elementos de la directiva y los elementos secundarios en el orden proporcionado en la instrucción de directiva. Obtenga más información sobre el establecimiento o modificación de directivas de API Management.

Instrucción de la directiva

XML

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

Atributos

Atributo	Descripción	Necesario	Valor predeterminado
response-variable-name	Nombre de la variable de contexto a la que se hace referencia, por ejemplo, desde una directiva send-request de canal de subida y que contiene un objeto Response. No se permiten expresiones de directiva.	No	N/D

Elementos

Elemento	Descripción	Requerido
set-status	Establece el código de estado de la respuesta.	No
set-header	Establece un encabezado en la respuesta.	No
set-body	Establece el cuerpo en la respuesta.	No

Uso

• Secciones de directiva: entrante, saliente, back-end, on-error
• Á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

• Una plantilla liquida no funciona cuando se especifica dentro del cuerpo (se establece mediante set-body) de la directiva return-response. La directiva return-response cancela la canalización de ejecución actual y quita el cuerpo de la solicitud y de la respuesta en el contexto actual. Como resultado, una plantilla liquida especificada dentro de la directiva recibe una cadena vacía como entrada y no generará la salida esperada.

Ejemplo

XML

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

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
• Kit de herramientas de directivas de Azure API Management
• Creación de directivas mediante Microsoft Copilot en Azure