Microsoft.AspNetCore.Http.Extensions
Specifies a description for the endpoint in .
The OpenAPI specification supports a description attribute on operations and parameters that
can be used to annotate endpoints with detailed, multiline descriptors of their behavior.
Initializes an instance of the .
The description associated with the endpoint or parameter.
>
Specifies a summary in .
Initializes an instance of the .
The summary associated with the endpoint or parameter.
>
Extension methods for accessing strongly typed HTTP request and response
headers.
Gets strongly typed HTTP request headers.
The .
The .
Gets strongly typed HTTP response headers.
The .
The .
Appends a sequence of values to .
The type of header value.
The .
The header name.
The values to append.
Extensions for reading HTTP server variables.
Gets the value of a server variable for the current request.
The http context for the request.
The name of the variable.
null if the server does not support the feature.
May return null or empty if the variable does not exist or is not set.
Extension methods to read the request body as JSON.
Read JSON from the request and deserialize to the specified type.
If the request's content-type is not a known JSON type then an error will be thrown.
The type of object to read.
The request to read from.
A used to cancel the operation.
The task object representing the asynchronous operation.
Read JSON from the request and deserialize to the specified type.
If the request's content-type is not a known JSON type then an error will be thrown.
The type of object to read.
The request to read from.
The serializer options to use when deserializing the content.
A used to cancel the operation.
The task object representing the asynchronous operation.
Read JSON from the request and deserialize to the specified type.
If the request's content-type is not a known JSON type then an error will be thrown.
The request to read from.
Metadata about the type to convert.
A used to cancel the operation.
The deserialized value.
Read JSON from the request and deserialize to object type.
If the request's content-type is not a known JSON type then an error will be thrown.
The request to read from.
Metadata about the type to convert.
A used to cancel the operation.
The deserialized value.
Read JSON from the request and deserialize to the specified type.
If the request's content-type is not a known JSON type then an error will be thrown.
The request to read from.
The type of object to read.
A used to cancel the operation.
The task object representing the asynchronous operation.
Read JSON from the request and deserialize to the specified type.
If the request's content-type is not a known JSON type then an error will be thrown.
The request to read from.
The type of object to read.
The serializer options use when deserializing the content.
A used to cancel the operation.
The task object representing the asynchronous operation.
Read JSON from the request and deserialize to the specified type.
If the request's content-type is not a known JSON type then an error will be thrown.
The request to read from.
The type of object to read.
A metadata provider for serializable types.
A used to cancel the operation.
The deserialized value.
Checks the Content-Type header for JSON types.
true if the Content-Type header represents a JSON content type; otherwise, false.
Extension methods for working with multipart form requests.
Gets the multipart boundary from the Content-Type header.
The .
The multipart boundary.
Allows constructing a query string.
Initializes a new instance of .
Initializes a new instance of .
The parameters to initialize the instance with.
Initializes a new instance of .
The parameters to initialize the instance with.
Adds a query string token to the instance.
The query key.
The sequence of query values.
Adds a query string token to the instance.
The query key.
The query value.
Constructs a from this .
The .
Provides APIs to copy a range of bytes from a source to a destination .
Asynchronously reads the given number of bytes from the source stream and writes them to another stream.
A task that represents the asynchronous copy operation.
The stream from which the contents will be copied.
The stream to which the contents of the current stream will be copied.
The count of bytes to be copied.
The token to monitor for cancellation requests. The default value is .
Asynchronously reads the given number of bytes from the source stream and writes them to another stream, using a specified buffer size.
A task that represents the asynchronous copy operation.
The stream from which the contents will be copied.
The stream to which the contents of the current stream will be copied.
The count of bytes to be copied.
The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.
The token to monitor for cancellation requests. The default value is .
A helper class for constructing encoded Uris for use in headers and other Uris.
Combines the given URI components into a string that is properly encoded for use in HTTP headers.
The first portion of the request path associated with application root.
The portion of the request path that identifies the requested resource.
The query, if any.
The fragment, if any.
The combined URI components, properly encoded for use in HTTP headers.
Combines the given URI components into a string that is properly encoded for use in HTTP headers.
Note that unicode in the HostString will be encoded as punycode.
http, https, etc.
The host portion of the uri normally included in the Host header. This may include the port.
The first portion of the request path associated with application root.
The portion of the request path that identifies the requested resource.
The query, if any.
The fragment, if any.
The combined URI components, properly encoded for use in HTTP headers.
Separates the given absolute URI string into components. Assumes no PathBase.
A string representation of the uri.
http, https, etc.
The host portion of the uri normally included in the Host header. This may include the port.
The portion of the request path that identifies the requested resource.
The query, if any.
The fragment, if any.
Generates a string from the given absolute or relative Uri that is appropriately encoded for use in
HTTP headers. Note that a unicode host name will be encoded as punycode.
The Uri to encode.
The encoded string version of .
Returns the combined components of the request URL in a fully escaped form suitable for use in HTTP headers
and other HTTP operations.
The request to assemble the uri pieces from.
The encoded string version of the URL from .
Returns the relative URI.
The request to assemble the uri pieces from.
The path and query off of .
Returns the combined components of the request URL in a fully un-escaped form (except for the QueryString)
suitable only for display. This format should not be used in HTTP headers or other HTTP operations.
The request to assemble the uri pieces from.
The combined components of the request URL in a fully un-escaped form (except for the QueryString)
suitable only for display.
Copies the specified to the specified starting at the specified .
The buffer to copy text to.
The buffer start index.
The text to copy.
Initializes the URI for .
The URI 's buffer.
The URI parts.
Provides extension methods for writing a JSON serialized value to the HTTP response.
Write the specified value as JSON to the response body. The response content-type will be set to
application/json; charset=utf-8.
The type of object to write.
The response to write JSON to.
The value to write as JSON.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
application/json; charset=utf-8.
The type of object to write.
The response to write JSON to.
The value to write as JSON.
The serializer options to use when serializing the value.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
the specified content-type.
The type of object to write.
The response to write JSON to.
The value to write as JSON.
The serializer options to use when serializing the value.
The content-type to set on the response.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
the specified content-type.
The type of object to write.
The response to write JSON to.
The value to write as JSON.
Metadata about the type to convert.
The content-type to set on the response.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
the specified content-type.
The response to write JSON to.
The value to write as JSON.
Metadata about the type to convert.
The content-type to set on the response.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
application/json; charset=utf-8.
The response to write JSON to.
The value to write as JSON.
The type of object to write.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
application/json; charset=utf-8.
The response to write JSON to.
The value to write as JSON.
The type of object to write.
The serializer options to use when serializing the value.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
the specified content-type.
The response to write JSON to.
The value to write as JSON.
The type of object to write.
The serializer options to use when serializing the value.
The content-type to set on the response.
A used to cancel the operation.
The task object representing the asynchronous operation.
Write the specified value as JSON to the response body. The response content-type will be set to
the specified content-type.
The response to write JSON to.
The value to write as JSON.
The type of object to write.
A metadata provider for serializable types.
The content-type to set on the response.
A used to cancel the operation.
The task object representing the asynchronous operation.
Options to configure JSON serialization settings for
and .
Gets the .
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
Defines the source generated JSON serialization contract metadata for a given type.
The default associated with a default instance.
The source-generated options associated with this context.
Adds the ProblemDetailsJsonContext to the current JsonSerializerOptions.
This allows for consistent serialization behavior for ProblemDetails regardless if
the default reflection-based serializer is used or not. And makes it trim/NativeAOT compatible.
Options for controlling the behavior of
and similar methods.
The operation that customizes the current instance.
Creates implementations from request handlers.
Returns metadata inferred automatically for the created by .
This includes metadata inferred by and implemented by parameter and return types to the .
The for the route handler to be passed to .
The options that will be used when calling .
The to be passed to .
Creates a implementation for .
A request handler with any number of custom parameters that often produces a response with its return value.
The used to configure the behavior of the handler.
The .
Creates a implementation for .
A request handler with any number of custom parameters that often produces a response with its return value.
The used to configure the behavior of the handler.
The result returned from if that was used to inferring metadata before creating the final RequestDelegate.
If , this call to method will infer the metadata that
would have inferred for the same and populate
with that metadata. Otherwise, this metadata inference will be skipped as this step has already been done.
The .
Creates a implementation for .
A request handler with any number of custom parameters that often produces a response with its return value.
Creates the for the non-static method.
The used to configure the behavior of the handler.
The .
Creates a implementation for .
A request handler with any number of custom parameters that often produces a response with its return value.
Creates the for the non-static method.
The used to configure the behavior of the handler.
The result returned from if that was used to inferring metadata before creating the final RequestDelegate.
If , this call to method will infer the metadata that
would have inferred for the same and populate
with that metadata. Otherwise, this metadata inference will be skipped as this step has already been done.
The .
Options for controlling the behavior of the when created using .
The instance used to access application services.
The list of route parameter names that are specified for this handler.
Controls whether the should throw a in addition to
writing a log when handling invalid requests.
Prevent the from inferring a parameter should be bound from the request body without an attribute that implements .
The mutable used to assist in the creation of the .
This is primarily used to run and populate inferred .
The must be . After the call to ,
will be the same as .
Any metadata already in will be included in before
most metadata inferred during creation of the and before any metadata provided by types in
the delegate signature that implement or . The exception to this general rule is the
that infers automatically
without any custom metadata providers which instead is inserted at the start to give it lower precedence. Custom metadata providers can choose to
insert their metadata at the start to give lower precedence, but this is unusual.
The metadata inferred by .
will be automatically populated with this metadata if provided.
If this is passed to ,
it will not repeat metadata inference. Any metadata that would be inferred should already be stored in the EndpointBuilder.
Gets endpoint metadata inferred from creating the . If a non-null
RequestDelegateFactoryOptions.EndpointMetadata list was passed in, this will be the same instance.
Strongly typed HTTP request headers.
Initializes a new instance of .
The request headers.
Gets the backing request header dictionary.
Gets or sets the Accept header for an HTTP request.
Gets or sets the Accept-Charset header for an HTTP request.
Gets or sets the Accept-Encoding header for an HTTP request.
Gets or sets the Accept-Language header for an HTTP request.
Gets or sets the Cache-Control header for an HTTP request.
Gets or sets the Content-Disposition header for an HTTP request.
Gets or sets the Content-Length header for an HTTP request.
Gets or sets the Content-Range header for an HTTP request.
Gets or sets the Content-Type header for an HTTP request.
Gets or sets the Cookie header for an HTTP request.
Gets or sets the Date header for an HTTP request.
Gets or sets the Expires header for an HTTP request.
Gets or sets the Host header for an HTTP request.
Gets or sets the If-Match header for an HTTP request.
Gets or sets the If-Modified-Since header for an HTTP request.
Gets or sets the If-None-Match header for an HTTP request.
Gets or sets the If-Range header for an HTTP request.
Gets or sets the If-Unmodified-Since header for an HTTP request.
Gets or sets the Last-Modified header for an HTTP request.
Gets or sets the Range header for an HTTP request.
Gets or sets the Referer header for an HTTP request.
Gets the value of header with .
must contain a TryParse method with the signature public static bool TryParse(string, out T).
The type of the header.
The given type must have a static TryParse method.
The name of the header to retrieve.
The value of the header.
Gets the values of header with .
must contain a TryParseList method with the signature public static bool TryParseList(IList<string>, out IList<T>).
The type of the header.
The given type must have a static TryParseList method.
The name of the header to retrieve.
List of values of the header.
Sets the header value.
The header name.
The header value.
Sets the specified header and it's values.
The type of the value.
The header name.
The sequence of header values.
Appends the header name and value.
The header name.
The header value.
Appends the header name and it's values.
The header name.
The header values.
Strongly typed HTTP response headers.
Initializes a new instance of .
The request headers.
Gets the backing response header dictionary.
Gets or sets the Cache-Control header for an HTTP response.
Gets or sets the Content-Disposition header for an HTTP response.
Gets or sets the Content-Length header for an HTTP response.
Gets or sets the Content-Range header for an HTTP response.
Gets or sets the Content-Type header for an HTTP response.
Gets or sets the Date header for an HTTP response.
Gets or sets the ETag header for an HTTP response.
Gets or sets the Expires header for an HTTP response.
Gets or sets the Last-Modified header for an HTTP response.
Gets or sets the Location header for an HTTP response.
Gets or sets the Set-Cookie header for an HTTP response.
Gets the value of header with .
must contain a TryParse method with the signature public static bool TryParse(string, out T).
The type of the header.
The given type must have a static TryParse method.
The name of the header to retrieve.
The value of the header.
Gets the values of header with .
must contain a TryParseList method with the signature public static bool TryParseList(IList<string>, out IList<T>).
The type of the header.
The given type must have a static TryParseList method.
The name of the header to retrieve.
List of values of the header.
Sets the header value.
The header name.
The header value.
Sets the specified header and it's values.
The type of the value.
The header name.
The sequence of header values.
Appends the header name and value.
The header name.
The header value.
Appends the header name and it's values.
The header name.
The header values.
Extension methods for .
Clears the HTTP response.
This invocation resets the response headers, response status code, and response body.
The to clear.
Returns a redirect response (HTTP 301, HTTP 302, HTTP 307 or HTTP 308) to the client.
The to redirect.
The URL to redirect the client to. This must be properly encoded for use in http headers where only ASCII characters are allowed.
True if the redirect is permanent (301 or 308), otherwise false (302 or 307).
True if the redirect needs to reuse the method and body (308 or 307), otherwise false (301 or 302).
Provides extensions for HttpResponse exposing the SendFile extension.
Sends the given file using the SendFile extension.
The file.
The .
Sends the given file using the SendFile extension.
The file.
The offset in the file.
The number of bytes to send, or null to send the remainder of the file.
Sends the given file using the SendFile extension.
The full path to the file.
The .
Sends the given file using the SendFile extension.
The full path to the file.
The offset in the file.
The number of bytes to send, or null to send the remainder of the file.
Extension methods for .
Sets an int value in the .
The .
The key to assign.
The value to assign.
Gets an int value from .
The .
The key to read.
Sets a value in the .
The .
The key to assign.
The value to assign.
Gets a string value from .
The .
The key to read.
Gets a byte-array value from .
The .
The key to read.
Specifies a collection of tags in .
The OpenAPI specification supports a tags classification to categorize operations
into related groups. These tags are typically included in the generated specification
and are typically used to group operations by tags in the UI.
Initializes an instance of the .
The tags associated with the endpoint.
Gets the collection of tags associated with the endpoint.
Unwraps all parameters that contains and
creates a flat list merging the current parameters, not including the
parameters that contain a , and all additional
parameters detected.
List of parameters to be flattened.
An instance of the method cache class.
Flat list of parameters.
Asynchronously reads the given number of bytes from the source stream and writes them to another stream.
A task that represents the asynchronous copy operation.
The stream from which the contents will be copied.
The stream to which the contents of the current stream will be copied.
The count of bytes to be copied.
The token to monitor for cancellation requests. The default value is .
Asynchronously reads the given number of bytes from the source stream and writes them to another stream, using a specified buffer size.
A task that represents the asynchronous copy operation.
The stream from which the contents will be copied.
The stream to which the contents of the current stream will be copied.
The count of bytes to be copied.
The size, in bytes, of the buffer. This value must be greater than zero. The default size is 4096.
The token to monitor for cancellation requests. The default value is .
This API supports the logging infrastructure and is not intended to be used directly from your code. It is subject to change in the future.
This API supports the logging infrastructure and is not intended to be used directly from your code. It is subject to change in the future.
This API supports the logging infrastructure and is not intended to be used directly from your code. It is subject to change in the future.
The value '{0}' is not a valid key for '{1}'.
The value '{0}' is not a valid key for '{1}'.
The value '{0}' is not valid for '{1}'.
The value '{0}' is not valid for '{1}'.
An error occurred while trying to map a value from form data. For more details, see the 'Error' property and the 'InnerException' property.
The number of elements in the {0} exceeded the maximum number of '{1}' elements allowed.
The number of elements in the {0} exceeded the maximum number of '{1}' elements allowed.
The value '{0}' is not valid for '{1}'.
The value '{0}' is not valid for '{1}'.
Extension methods to configure JSON serialization behavior.
Configures options used for reading and writing JSON when using
and .
uses default values from JsonSerializerDefaults.Web.
The to configure options on.
The to configure the
, uses default values from JsonSerializerDefaults.Web.
The modified .
Contains extension methods to .
Adds services required for creation of for failed requests.
The to add the services to.
The so that additional calls can be chained.
Adds services required for creation of for failed requests.
The to add the services to.
The to configure the services with.
The so that additional calls can be chained.
Executes the configured method on . This can be used whether or not
the configured method is asynchronous.
Even if the target method is asynchronous, it's desirable to invoke it using Execute rather than
ExecuteAsync if you know at compile time what the return type is, because then you can directly
"await" that value (via a cast), and then the generated code will be able to reference the
resulting awaitable as a value-typed variable. If you use ExecuteAsync instead, the generated
code will have to treat the resulting awaitable as a boxed object, because it doesn't know at
compile time what type it would be.
The object whose method is to be executed.
Parameters to pass to the method.
The method return value.
Executes the configured method on . This can only be used if the configured
method is asynchronous.
If you don't know at compile time the type of the method's returned awaitable, you can use ExecuteAsync,
which supplies an awaitable-of-object. This always works, but can incur several extra heap allocations
as compared with using Execute and then using "await" on the result value typecasted to the known
awaitable type. The possible extra heap allocations are for:
1. The custom awaitable (though usually there's a heap allocation for this anyway, since normally
it's a reference type, and you normally create a new instance per call).
2. The custom awaiter (whether or not it's a value type, since if it's not, you need a new instance
of it, and if it is, it will have to be boxed so the calling code can reference it as an object).
3. The async result value, if it's a value type (it has to be boxed as an object, since the calling
code doesn't know what type it's going to be).
The object whose method is to be executed.
Parameters to pass to the method.
An object that you can "await" to get the method return value.
Provides a common awaitable structure that can
return, regardless of whether the underlying value is a System.Task, an FSharpAsync, or an
application-defined custom awaitable.
Helper for detecting whether a given type is FSharpAsync`1, and if so, supplying
an for mapping instances of that type to a C# awaitable.
The main design goal here is to avoid taking a compile-time dependency on
FSharp.Core.dll, because non-F# applications wouldn't use it. So all the references
to FSharp types have to be constructed dynamically at runtime.
Pretty print a type name.
The .
true to print a fully qualified name.
true to include generic parameter names.
true to include generic parameters.
Character to use as a delimiter in nested type names
The pretty printed type name.
Helper related to generic interface definitions and implementing classes.
Determine whether is or implements a closed generic
created from .
The of interest.
The open generic to match. Usually an interface.
The closed generic created from that
is or implements. null if the two s have no such
relationship.
This method will return if is
typeof(KeyValuePair{,}), and is
typeof(KeyValuePair{string, object}).
Get a pinnable reference to the builder.
Does not ensure there is a null char after
This overload is pattern matched in the C# 7.3+ compiler so you can omit
the explicit method call, and write eg "fixed (char* c = builder)"
Get a pinnable reference to the builder.
Ensures that the builder has a null char after
Returns the underlying storage of the builder.
Returns a span around the contents of the builder.
Ensures that the builder has a null char after
Resize the internal buffer either by doubling current buffer size or
by adding to
whichever is greater.
Number of chars requested beyond current position.