Microsoft.AspNetCore.Http Namespace

Contains types for handling HTTP requests and responses.

Classes

AsParametersAttribute

Specifies that a route handler delegate's parameter represents a structured parameter list.

BadHttpRequestException

Represents an HTTP request error

BindingAddress

An address that a HTTP server may bind to.

ConnectionInfo

Represents the underlying connection for a request.

CookieBuilder

Defines settings used to create a cookie.

CookieOptions

Options used to create a new cookie.

DefaultEndpointFilterInvocationContext

Provides a default implementation for wrapping the HttpContext and parameters provided to a route handler.

DefaultHttpContext

Represents an implementation of the HTTP Context class.

DefaultHttpContextFactory

A factory for creating HttpContext instances.

Endpoint

Represents a logical endpoint in an application.

EndpointDescriptionAttribute

Specifies a description for the endpoint in Metadata.

EndpointFilterExtensions

Extension methods for adding IEndpointFilter to a route handler.

EndpointFilterFactoryContext

Represents the information accessible via the route handler filter API when the user is constructing a new route handler.

EndpointFilterInvocationContext

Provides an abstraction for wrapping the HttpContext and arguments provided to a route handler.

EndpointHttpContextExtensions

Extension methods to expose Endpoint on HttpContext.

EndpointMetadataCollection

A collection of arbitrary metadata associated with an endpoint.

EndpointSummaryAttribute

Specifies a summary in Metadata.

FormCollection

Contains the parsed HTTP form values.

FormFile

Default implementation of IFormFile.

FormFileCollection

Default implementation of IFormFileCollection.

HeaderDictionary

Represents a wrapper for RequestHeaders and ResponseHeaders.

HeaderDictionaryExtensions

Contains extension methods for modifying an IHeaderDictionary instance.

HeaderDictionaryTypeExtensions

Extension methods for accessing strongly typed HTTP request and response headers.

HeaderParsingHttpRequestExtensions

Extensions for header parsing.

HttpContext

Encapsulates all HTTP-specific information about an individual HTTP request.

HttpContextAccessor

Provides an implementation of IHttpContextAccessor based on the current execution context.

HttpContextFactory

Represents methods used to create an HTTP context object.

HttpContextServerVariableExtensions

Extensions for reading HTTP server variables.

HttpMethods

Contains methods to verify the request method of an HTTP request.

HttpProtocol

Contains methods to verify the request protocol version of an HTTP request.

HttpRequest

Represents the incoming side of an individual HTTP request.

HttpRequestJsonExtensions

Extension methods to read the request body as JSON.

HttpRequestRewindExtensions

Extension methods for enabling buffering in an HttpRequest.

HttpResponse

Represents the outgoing side of an individual HTTP request.

HttpResponseJsonExtensions

Provides extension methods for writing a JSON serialized value to the HTTP response.

HttpResponseWritingExtensions

Convenience methods for writing to the response.

HttpValidationProblemDetails

A ProblemDetails for validation errors.

MiddlewareFactory

Default implementation for IMiddlewareFactory.

OpenApiRouteHandlerBuilderExtensions

Extension methods for adding Metadata that is meant to be consumed by OpenAPI libraries.

ProblemDetailsContext

Represent the current problem details context for the request.

ProblemDetailsOptions

Options for controlling the behavior of WriteAsync(ProblemDetailsContext) and similar methods.

ProducesResponseTypeMetadata

Specifies the type of the value and status code returned by the action.

QueryCollection

The HttpRequest query string collection

RequestDelegateFactory

Creates RequestDelegate implementations from Delegate request handlers.

RequestDelegateFactoryOptions

Options for controlling the behavior of the RequestDelegate when created using RequestDelegateFactory.

RequestDelegateMetadataResult

The metadata inferred by InferMetadata(MethodInfo, RequestDelegateFactoryOptions). EndpointBuilder will be automatically populated with this metadata if provided. If this is passed to Create(Delegate, RequestDelegateFactoryOptions, RequestDelegateMetadataResult), it will not repeat metadata inference. Any metadata that would be inferred should already be stored in the EndpointBuilder.

RequestDelegateResult

The result of creating a RequestDelegate from a Delegate

RequestFormReaderExtensions

Extension for HttpRequest.

RequestTrailerExtensions

HttpRequest extensions for working with request trailing headers.

ResponseExtensions

Extension methods for HttpResponse.

ResponseTrailerExtensions

Contains extension methods for modifying the Trailer response header and trailing headers in an HttpResponse.

Results

A factory for IResult.

SendFileFallback

Helper type that allows copying a file to a Stream.

This type is part of ASP.NET Core's infrastructure and should not used by application code.

SendFileResponseExtensions

Provides extensions for HttpResponse exposing the SendFile extension.

SessionExtensions

Extension methods for ISession.

StatusCodes

A collection of constants for HTTP status codes.

StreamResponseBodyFeature

An implementation of IHttpResponseBodyFeature that aproximates all of the APIs over the given Stream.

TagsAttribute

Specifies a collection of tags in Metadata.

TypedResults

A typed factory for IResult types in Microsoft.AspNetCore.Http.HttpResults.

WebSocketAcceptContext

A context for negotiating a websocket upgrade.

WebSocketManager

Manages the establishment of WebSocket connections for a specific HTTP request.

Structs

EndpointMetadataCollection.Enumerator

Enumerates the elements of an EndpointMetadataCollection.

FormCollection.Enumerator

Enumerates a FormCollection.

FragmentString

Provides correct handling for FragmentString value when needed to generate a URI string

HeaderDictionary.Enumerator

Enumerates a HeaderDictionary.

HostString

Represents the host portion of a URI can be used to construct URI's properly formatted and encoded for use in HTTP headers.

PathString

Provides correct escaping for Path and PathBase values when needed to reconstruct a request or redirect URI string

QueryCollection.Enumerator

Enumerates a QueryCollection.

QueryString

Provides correct handling for QueryString value when needed to reconstruct a request or redirect URI string

Interfaces

IBindableFromHttpContext<TSelf>

Defines a mechanism for creating an instance of a type from an HttpContext when binding parameters for an endpoint route handler delegate.

IContentTypeHttpResult

Defines a contract that represents the result of an HTTP endpoint that contains a ContentType.

IEndpointFilter

Provides an interface for implementing a filter targetting a route handler.

IFileHttpResult

Defines a contract that represents the file result of an HTTP endpoint.

IFormCollection

Represents the parsed form values sent with the HttpRequest.

IFormFile

Represents a file sent with the HttpRequest.

IFormFileCollection

Represents the collection of files sent with the HttpRequest.

IHeaderDictionary

Represents HttpRequest and HttpResponse headers

IHttpContextAccessor

Provides access to the current HttpContext, if one is available.

IHttpContextFactory

Provides methods to create and dispose of HttpContext instances.

IMiddleware

Defines middleware that can be added to the application's request pipeline.

IMiddlewareFactory

Provides methods to create middleware.

INestedHttpResult

Defines a contract that represents the result of an HTTP endpoint that contains a nested IResult type.

IProblemDetailsService

Defines a type that provide functionality to create a ProblemDetails response.

IProblemDetailsWriter

Defines a type that write a ProblemDetails payload to the current Response.

IQueryCollection

Represents the HttpRequest query string collection

IRequestCookieCollection

Represents the HttpRequest cookie collection

IResponseCookies

A wrapper for the response Set-Cookie header.

IResult

Defines a contract that represents the result of an HTTP endpoint.

IResultExtensions

Provides an interface to registering external methods that provide custom IResult instances.

ISession

Stores user data while the user browses a web application. Session state uses a store maintained by the application to persist data across requests from a client. The session data is backed by a cache and considered ephemeral data.

IStatusCodeHttpResult

Defines a contract that represents the result of an HTTP endpoint that contains a StatusCode.

IValueHttpResult

Defines a contract that represents the result of an HTTP endpoint that contains an object Value.

IValueHttpResult<TValue>

Defines a contract that represents the result of an HTTP endpoint that contains a Value.

Enums

CookieSecurePolicy

Determines how cookie security properties are set.

SameSiteMode

Used to set the SameSite field on response cookies to indicate if those cookies should be included by the client on future "same-site" or "cross-site" requests. RFC Draft: https://tools.ietf.org/html/draft-ietf-httpbis-rfc6265bis-03#section-4.1.1

Delegates

EndpointFilterDelegate

A delegate that is applied as a filter on a route handler.

RequestDelegate

A function that can process an HTTP request.

Remarks

For more information about low-level HTTP APIs, see Access HttpContext in ASP.NET Core.