Návratová odpověď

  • Článek

PLATÍ PRO: Všechny úrovně služby API Management

Zásada return-response zruší spuštění kanálu a vrátí volajícímu výchozí nebo vlastní odpověď. Výchozí odpověď není 200 OK bez textu. Vlastní odpověď je možné zadat prostřednictvím kontextové proměnné nebo prohlášení zásad. Pokud je k dispozici obojí, odpověď obsažená v kontextové proměnné se před vrácením volajícímu upraví příkazy zásad.

Poznámka:

Nastavte prvky zásad a podřízené prvky v pořadí uvedeném v prohlášení o zásadách. Přečtěte si další informace o tom, jak nastavit nebo upravit zásady služby API Management.

Prohlášení o zásadách

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

Atributy

Atribut Popis Požaduje se Výchozí
response-variable-name Název kontextové proměnné odkazované například z upstreamové zásady požadavku na odeslání a obsahující Response objekt. Výrazy zásad nejsou povolené. No –

Elementy

Element (Prvek) Popis Povinní účastníci
set-status Nastaví stavový kód odpovědi. No
set-header Nastaví hlavičku v odpovědi. No
set-body Nastaví tělo v odpovědi. No

Využití

  • Oddíly zásad: příchozí, odchozí, back-end, on-error
  • Obory zásad: globální, pracovní prostor, produkt, rozhraní API, operace
  • Brány: Classic, v2, consumption, self-hosted

Poznámky k využití

  • Při zadání uvnitř těla (nastaveného return-response pomocíset-body) zásady nefunguje šablona liquid. Zásada return-response zruší aktuální kanál spuštění a odebere text požadavku a text odpovědi v aktuálním kontextu. V důsledku toho šablona liquid zadaná uvnitř zásady obdrží jako vstup prázdný řetězec a nevygeneruje očekávaný výstup.

Příklad

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

Související obsah

Další informace o práci se zásadami najdete v tématech: