Class PathTransformExtensions

Extensions for adding path transforms.

Inheritance

System.Object

PathTransformExtensions

Namespace: Yarp.ReverseProxy.Transforms

Assembly: Yarp.ReverseProxy.dll

Syntax

public static class PathTransformExtensions : object

Methods

| Improve this Doc View Source

AddPathPrefix(TransformBuilderContext, PathString)

Adds the transform which will prefix the request path with the given value.

Declaration

public static TransformBuilderContext AddPathPrefix(this TransformBuilderContext context, PathString prefix)

Parameters

Type	Name	Description
TransformBuilderContext	context
PathString	prefix

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

AddPathRemovePrefix(TransformBuilderContext, PathString)

Adds the transform which will remove the matching prefix from the request path.

Declaration

public static TransformBuilderContext AddPathRemovePrefix(this TransformBuilderContext context, PathString prefix)

Parameters

Type	Name	Description
TransformBuilderContext	context
PathString	prefix

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

AddPathRouteValues(TransformBuilderContext, PathString)

Clones the route and adds the transform which will set the request path with the given value.

Declaration

public static TransformBuilderContext AddPathRouteValues(this TransformBuilderContext context, PathString pattern)

Parameters

Type	Name	Description
TransformBuilderContext	context
PathString	pattern

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

AddPathSet(TransformBuilderContext, PathString)

Adds the transform which sets the request path with the given value.

Declaration

public static TransformBuilderContext AddPathSet(this TransformBuilderContext context, PathString path)

Parameters

Type	Name	Description
TransformBuilderContext	context
PathString	path

Returns

Type	Description
TransformBuilderContext

| Improve this Doc View Source

WithTransformPathPrefix(RouteConfig, PathString)

Clones the route and adds the transform which will prefix the request path with the given value.

Declaration

public static RouteConfig WithTransformPathPrefix(this RouteConfig route, PathString prefix)

Parameters

Type	Name	Description
RouteConfig	route
PathString	prefix

Returns

Type	Description
RouteConfig

| Improve this Doc View Source

WithTransformPathRemovePrefix(RouteConfig, PathString)

Clones the route and adds the transform which will remove the matching prefix from the request path.

Declaration

public static RouteConfig WithTransformPathRemovePrefix(this RouteConfig route, PathString prefix)

Parameters

Type	Name	Description
RouteConfig	route
PathString	prefix

Returns

Type	Description
RouteConfig

| Improve this Doc View Source

WithTransformPathRouteValues(RouteConfig, PathString)

Clones the route and adds the transform which will set the request path with the given value.

Declaration

public static RouteConfig WithTransformPathRouteValues(this RouteConfig route, PathString pattern)

Parameters

Type	Name	Description
RouteConfig	route
PathString	pattern

Returns

Type	Description
RouteConfig

| Improve this Doc View Source

WithTransformPathSet(RouteConfig, PathString)

Clones the route and adds the transform which sets the request path with the given value.

Declaration

public static RouteConfig WithTransformPathSet(this RouteConfig route, PathString path)

Parameters

Type	Name	Description
RouteConfig	route
PathString	path

Returns

Type	Description
RouteConfig