Трансформации на отговори и трейлъри

Отговор и трейлъри на отговора

По подразбиране всички заглавни части и трейлъри на отговора се копират от проксирания отговор в изходящия отговор към клиента. Трансформациите на отговора и на трейлърите на отговора могат да зададат дали да се прилагат само за успешни отговори, или за всички отговори.

В кода те се реализират като производни на абстрактните класове ResponseTransform и ResponseTrailersTransform.

ResponseHeadersCopy

Задава дали заглавните части на отговора от дестинацията се копират към клиента

Key Value Default Expand table ResponseHeadersCopy true/false true Required yes

Конфигурация:

JSON { "ResponseHeadersCopy": "false" }

Код:

C# routeConfig = routeConfig.WithTransformCopyResponseHeaders(copy: false);

C# transformBuilderContext.CopyResponseHeaders = false;

Това задава дали всички заглавни части на прокси отговора се копират в отговора към клиента. Тази настройка е активирана по подразбиране и може да бъде деактивирана чрез конфигуриране на трансформацията със стойност false. Трансформации, които се отнасят до конкретни заглавни части, продължават да се изпълняват, дори ако това е деактивирано.

ResponseHeader

Добавя или заменя заглавни части на отговора

Key Value Default Expand table ResponseHeader The header name (none) Required Set/Append The header value (none) yes When Success/Always/Failure Success yes no

Конфигурация:

JSON   {
       "ResponseHeader": "HeaderName",
       "Append": "value",
       "When": "Success"
   }
Code:

C#   routeConfig = routeConfig.WithTransformResponseHeader(headerName: "HeaderName",
   value: "value", append: true, ResponseCondition.Success);
    C#
   transformBuilderContext.AddResponseHeader(headerName: "HeaderName", value:
   "value", append: true, always: ResponseCondition.Success);
Example:
   HeaderName: value
This sets or appends the value for the named response header. Set replaces any existing
header. Append adds an additional header with the given value. Note: setting "" as a header
value is not recommended and can cause an undefined behavior.
When specifies if the response header should be included for all, successful, or failure
responses. Any response with a status code less than 400 is considered a success.

ResponseHeaderRemove

Премахва заглавни части на отговора

Key Value Default Required ResponseHeaderRemove The header name (none) yes When Success/Always/Failure Success no

Конфигурация:

JSON{
   "ResponseHeaderRemove": "HeaderName",
   "When": "Success"
}
Code:

C#   routeConfig = routeConfig.WithTransformResponseHeaderRemove(headerName:
   "HeaderName", ResponseCondition.Success);
    C#
   transformBuilderContext.AddResponseHeaderRemove(headerName: "HeaderName",
   ResponseCondition.Success);
Example:
HeaderName: value
AnotherHeader: another-value
This removes the named response header.
When specifies if the response header should be removed for all, successful, or failure
responses. Any response with a status code less than 400 is considered a success.

ResponseHeadersAllowed

Key Value Required ResponseHeadersAllowed A semicolon separated list of allowed header names. yes

Конфигурация:

JSON   {
       "ResponseHeadersAllowed": "Header1;header2"
   }
Code:

C#   routeConfig = routeConfig.WithTransformResponseHeadersAllowed("Header1",
   "header2");

C#   transformBuilderContext.AddResponseHeadersAllowed("Header1", "header2");
YARP copies most response headers from the proxy response by default (see
ResponseHeadersCopy). Some security models only allow specific headers to be proxied. This
transform disables ResponseHeadersCopy and only copies the given headers. Other transforms
that modify or append to existing headers may be affected if not included in the allow list.
Note that there are some headers YARP does not copy by default since they are connection
specific or otherwise security sensitive (e.g. Connection , Alt-Svc ). Putting those header names
in the allow list will bypass that restriction but is strongly discouraged as it may negatively
affect the functionality of the proxy or cause security vulnerabilities.
Example:
Header1: value1
Header2: value2
AnotherHeader: AnotherValue
Only header1 and header2 are copied from the proxy response.

ResponseTrailersCopy

Задава дали трейлър заглавните части на отговора от дестинацията се копират към клиента

Key Value Default Expand table ResponseTrailersCopy true/false true Required yes

Конфигурация:

JSON { "ResponseTrailersCopy": "false" }

Код:

C# routeConfig = routeConfig.WithTransformCopyResponseTrailers(copy: false);

C# transformBuilderContext.CopyResponseTrailers = false;

Това задава дали всички трейлъри на прокси отговора се копират в отговора към клиента. Тази настройка е активирана по подразбиране и може да бъде деактивирана чрез конфигуриране на трансформацията със стойност false. Трансформации, които се отнасят до конкретни заглавни части, продължават да се изпълняват, дори ако това е деактивирано.

ResponseTrailer

Добавя или заменя трейлър заглавни части на отговора

https://learn.microsoft.com/en-us/aspnet/core/fundamentals/servers/yarp/transforms-response?view=aspnetcore-9.0 Expand table

5/8

Key Value Default Required ResponseTrailer Set/Append The header name (none) yes When The header value (none) yes

Success/Always/Failure Success no

Конфигурация:

JSON   {
       "ResponseTrailer": "HeaderName",
       "Append": "value",
       "When": "Success"
   }
Code:

C#   routeConfig = routeConfig.WithTransformResponseTrailer(headerName: "HeaderName",
   value: "value", append: true, ResponseCondition.Success);
    C#
   transformBuilderContext.AddResponseTrailer(headerName: "HeaderName", value:
   "value", append: true, ResponseCondition.Success);
Example:
HeaderName: value
Response trailers are headers sent at the end of the response body. Support for trailers is
uncommon in HTTP/1.1 implementations but is becoming common in HTTP/2
implementations. Check your client and server for support.
ResponseTrailer follows the same structure and guidance as ResponseHeader.

ResponseTrailerRemove

Премахва трейлър заглавни части на отговора

Key Expand table ResponseTrailerRemove When Value Default Required The header name (none) yes Success/Always/Failure Success no

Конфигурация:

JSON   {
       "ResponseTrailerRemove": "HeaderName",
       "When": "Success"
   }
Code:

C#   routeConfig = routeConfig.WithTransformResponseTrailerRemove(headerName:
   "HeaderName", ResponseCondition.Success);
    C#
   transformBuilderContext.AddResponseTrailerRemove(headerName: "HeaderName",
   ResponseCondition.Success);
Example:
   HeaderName: value
   AnotherHeader: another-value
This removes the named trailing header.
ResponseTrailerRemove follows the same structure and guidance as ResponseHeaderRemove.

ResponseTrailersAllowed

yes Key Value ResponseTrailersAllowed A semicolon separated list of allowed header names.

Конфигурация:

JSON{
   "ResponseTrailersAllowed": "Header1;header2"
}
Code:

C#   routeConfig = routeConfig.WithTransformResponseTrailersAllowed("Header1",
   "header2");

C#   transformBuilderContext.AddResponseTrailersAllowed("Header1", "header2");
YARP copies most response trailers from the proxy response by default (see
ResponseTrailersCopy). Some security models only allow specific headers to be proxied. This
transform disables ResponseTrailersCopy and only copies the given headers. Other transforms
that modify or append to existing headers may be affected if not included in the allow list.
Note that there are some headers YARP does not copy by default since they are connection
specific or otherwise security sensitive (e.g. Connection , Alt-Svc ). Putting those header names
in the allow list will bypass that restriction but is strongly discouraged as it may negatively
affect the functionality of the proxy or cause security vulnerabilities.
Example:
Header1: value1
Header2: value2
AnotherHeader: AnotherValue
Only header1 and header2 are copied from the proxy response.
 Note: The author created this article with assistance from AI. Learn more