Restituire la risposta
SI APPLICA A: Tutti i livelli di Gestione API
Il criterio return-response annulla l'esecuzione della pipeline e restituisce al chiamante una risposta predefinita o personalizzata. La risposta predefinita è 200 OK, senza corpo. La risposta personalizzata può essere specificata tramite una variabile di contesto o istruzioni di criteri. Quando vengono fornite entrambe le opzioni, la risposta contenuta nella variabile di contesto viene modificata dalle istruzioni dei criteri prima di essere restituita al chiamante.
Nota
Impostare gli elementi e gli elementi figlio del criterio nell'ordine specificato nell'istruzione del criterio. Altre informazioni su come impostare o modificare i criteri di API Management.
Istruzione del criterio
<return-response response-variable-name="existing context variable">
<set-status>...</set-status>
<set-header>...</set-header>
<set-body>...</set-body>
</return-response>
Attributi
| Attributo | Descrizione | Richiesto | Valore predefinito |
|---|---|---|---|
| response-variable-name | Nome della variabile di contesto a cui fa riferimento, ad esempio, un criterio di upstream send-request e contenente un oggetto Response. Le espressioni di criteri non sono consentite. |
No | N/D |
Elementi
| Elemento | Descrizione | Richiesto |
|---|---|---|
| set-status | Imposta il codice di stato della risposta. | No |
| set-header | Imposta un'intestazione nella risposta. | No |
| set-body | Imposta il corpo nella risposta. | No |
Utilizzo
- Sezioni del criterio: inbound, outbound, backend, on-error
- Ambiti del criterio: globale, area di lavoro, prodotto, API, operazione
- Gateway: classico, v2, consumo, self-hosted, area di lavoro
Note sull'utilizzo
- Un modello liquido non funziona se specificato all'interno del corpo (impostato usando
set-body) dei criteri direturn-response. Il criterioreturn-responseannulla la pipeline di esecuzione corrente e rimuove il corpo della richiesta e il corpo della risposta nel contesto corrente. Di conseguenza, un modello liquido specificato all'interno dei criteri riceve una stringa vuota come input e non produrrà l'output previsto.
Esempio
<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>
Criteri correlati
Contenuto correlato
Per ulteriori informazioni sull'utilizzo dei criteri, vedere:
- Esercitazione: trasformare e proteggere l'API
- Informazioni di riferimento sui criteri per un elenco completo delle istruzioni dei criteri e delle relative impostazioni
- Espressioni di criteri
- Impostare o modificare criteri
- Riutilizzare le configurazioni dei criteri
- Repository dei frammenti di criteri
- Creare criteri usando Microsoft Copilot in Azure