Early Preview

This is currently very much a preview. Please feel free to try things out, but don't be upset if anything is not yet working. Feedback is welcome over on our GitHub Dicussions page.

Microsoft.AspNetCore.Http.Abstractions

System Library

Author Microsoft
Version 10.0.1
Tags

Public Types

Microsoft.​AspNetCore.​Antiforgery

interface IAntiforgeryMetadata
A marker interface which can be used to identify antiforgery metadata.

Microsoft.​AspNetCore.​Builder

class EndpointBuilder
A base class for building an new <see cref="T:Microsoft.AspNetCore.Http.Endpoint" /> .
interface IApplicationBuilder
Defines a class that provides the mechanisms to configure an application's request pipeline.
interface IEndpointConventionBuilder
Builds conventions that will be used for customization of <see cref="T:Microsoft.AspNetCore.Builder.EndpointBuilder" /> instances.
class MapExtensions
Extension methods for the <see cref="T:Microsoft.AspNetCore.Builder.Extensions.MapMiddleware" /> .
class MapWhenExtensions
Extension methods for the <see cref="T:Microsoft.AspNetCore.Builder.Extensions.MapWhenMiddleware" /> .
class RunExtensions
Extension methods for adding terminal middleware.
class UseExtensions
Extension methods for adding middleware.
class UseMiddlewareExtensions
Extension methods for adding typed middleware.
class UsePathBaseExtensions
Extension methods for <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder" /> .
class UseWhenExtensions
Extension methods for <see cref="T:Microsoft.AspNetCore.Builder.IApplicationBuilder" /> .

Microsoft.​AspNetCore.​Builder.​Extensions

class MapMiddleware
Represents a middleware that maps a request path to a sub-request pipeline.
class MapOptions
Options for the <see cref="T:Microsoft.AspNetCore.Builder.Extensions.MapMiddleware" /> .
class MapWhenMiddleware
Represents a middleware that runs a sub-request pipeline when a given predicate is matched.
class MapWhenOptions
Options for the <see cref="T:Microsoft.AspNetCore.Builder.Extensions.MapWhenMiddleware" /> .
class UsePathBaseMiddleware
Represents a middleware that extracts the specified path base from request path and postpend it to the request path base.

Microsoft.​AspNetCore.​Cors.​Infrastructure

interface ICorsMetadata
A marker interface which can be used to identify CORS metadata.

Microsoft.​AspNetCore.​Http

class AsParametersAttribute
Specifies that a route handler delegate's parameter represents a structured parameter list.
class BadHttpRequestException
Represents an HTTP request error
class ConnectionInfo
Represents the underlying connection for a request.
class CookieBuilder
Defines settings used to create a cookie.
enum CookieSecurePolicy
Determines how cookie security properties are set.
class DefaultEndpointFilterInvocationContext
Provides a default implementation for wrapping the <see cref="P:Microsoft.AspNetCore.Http.DefaultEndpointFilterInvocationContext.HttpContext" /> and parameters provided to a route handler.
class Endpoint
Represents a logical endpoint in an application.
class EndpointFilterDelegate
A delegate that is applied as a filter on a route handler.
class EndpointFilterFactoryContext
Represents the information accessible via the route handler filter API when the user is constructing a new route handler.
class EndpointFilterInvocationContext
Provides an abstraction for wrapping the <see cref="P:Microsoft.AspNetCore.Http.EndpointFilterInvocationContext.HttpContext" /> and arguments provided to a route handler.
class EndpointHttpContextExtensions
Extension methods to expose Endpoint on HttpContext.
class EndpointMetadataCollection
A collection of arbitrary metadata associated with an endpoint.
struct FragmentString
Provides correct handling for FragmentString value when needed to generate a URI string
class HeaderDictionaryExtensions
Contains extension methods for modifying an <see cref="T:Microsoft.AspNetCore.Http.IHeaderDictionary" /> instance.
struct HostString
Represents the host portion of a URI can be used to construct URI's properly formatted and encoded for use in HTTP headers.
class HttpContext
Encapsulates all HTTP-specific information about an individual HTTP request.
class HttpMethods
Contains methods to verify the request method of an HTTP request.
class HttpProtocol
Contains methods to verify the request protocol version of an HTTP request.
class HttpRequest
Represents the incoming side of an individual HTTP request.
class HttpResponse
Represents the outgoing side of an individual HTTP request.
class HttpResponseWritingExtensions
Convenience methods for writing to the response.
class HttpValidationProblemDetails
A <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails" /> for validation errors.
interface IBindableFromHttpContext<​TSelf>
Defines a mechanism for creating an instance of a type from an <see cref="T:Microsoft.AspNetCore.Http.HttpContext" /> when binding parameters for an endpoint route handler delegate.
interface IContentTypeHttpResult
Defines a contract that represents the result of an HTTP endpoint that contains a <see cref="P:Microsoft.AspNetCore.Http.IContentTypeHttpResult.ContentType" /> .
interface IEndpointFilter
Provides an interface for implementing a filter targetting a route handler.
interface IFileHttpResult
Defines a contract that represents the file result of an HTTP endpoint.
interface IHttpContextAccessor
Provides access to the current <see cref="P:Microsoft.AspNetCore.Http.IHttpContextAccessor.HttpContext" /> , if one is available.
interface IHttpContextFactory
Provides methods to create and dispose of <see cref="T:Microsoft.AspNetCore.Http.HttpContext" /> instances.
interface IMiddleware
Defines middleware that can be added to the application's request pipeline.
interface IMiddlewareFactory
Provides methods to create middleware.
interface INestedHttpResult
Defines a contract that represents the result of an HTTP endpoint that contains a nested <see cref="T:Microsoft.AspNetCore.Http.IResult" /> type.
interface IProblemDetailsService
Defines a type that provide functionality to create a <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails" /> response.
interface IProblemDetailsWriter
Defines a type that write a <see cref="T:Microsoft.AspNetCore.Mvc.ProblemDetails" /> payload to the current <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Response" /> .
interface IResult
Defines a contract that represents the result of an HTTP endpoint.
interface IStatusCodeHttpResult
Defines a contract that represents the result of an HTTP endpoint that contains a <see cref="P:Microsoft.AspNetCore.Http.IStatusCodeHttpResult.StatusCode" /> .
interface IValueHttpResult
Defines a contract that represents the result of an HTTP endpoint that contains an object <see cref="P:Microsoft.AspNetCore.Http.IValueHttpResult.Value" /> .
interface IValueHttpResult<​TValue>
Defines a contract that represents the result of an HTTP endpoint that contains a <see cref="P:Microsoft.AspNetCore.Http.IValueHttpResult`1.Value" /> .
struct PathString
Provides correct escaping for Path and PathBase values when needed to reconstruct a request or redirect URI string
class ProblemDetailsContext
Represent the current problem details context for the request.
class ProducesResponseTypeMetadata
Specifies the type of the value and status code returned by the action.
struct QueryString
Provides correct handling for QueryString value when needed to reconstruct a request or redirect URI string
class RequestDelegate
A function that can process an HTTP request.
class RequestDelegateResult
The result of creating a <see cref="P:Microsoft.AspNetCore.Http.RequestDelegateResult.RequestDelegate" /> from a <see cref="T:System.Delegate" />
class RequestTrailerExtensions
HttpRequest extensions for working with request trailing headers.
class ResponseTrailerExtensions
Contains extension methods for modifying the `Trailer` response header and trailing headers in an <see cref="T:Microsoft.AspNetCore.Http.HttpResponse" /> .
class StatusCodes
A collection of constants for <see href="http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml">HTTP status codes</see> .
class WebSocketManager
Manages the establishment of WebSocket connections for a specific HTTP request.

Microsoft.​AspNetCore.​Http.​Features

interface IEndpointFeature
A feature interface for endpoint routing. Use <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Features" /> to access an instance associated with the current request.
interface IRouteValuesFeature
A feature interface for routing values. Use <see cref="P:Microsoft.AspNetCore.Http.HttpContext.Features" /> to access the values associated with the current request.

Microsoft.​AspNetCore.​Http.​HttpResults

class EmptyHttpResult
Represents an <see cref="T:Microsoft.AspNetCore.Http.IResult" /> that when executed will do nothing.

Microsoft.​AspNetCore.​Http.​Metadata

class AcceptsMetadata
Metadata that specifies the supported request content types.
class FormMappingOptionsMetadata
Supports configuring the behavior of form mapping in a minimal API.
interface IAcceptsMetadata
Interface for accepting request media types.
interface IAllowCookieRedirectMetadata
Metadata that indicates the endpoint should allow cookie-based authentication redirects. This is normally the default behavior, but it exists to override <see cref="T:Microsoft.AspNetCore.Http.Metadata.IDisableCookieRedirectMetadata" /> no matter the order. When present, the cookie authentication handler will prefer browser login or access denied redirects over 401 and 403 status codes.
interface IDisableCookieRedirectMetadata
Metadata that indicates the endpoint should disable cookie-based authentication redirects typically because it is intended for API clients rather than direct browser navigation. <see cref="T:Microsoft.AspNetCore.Http.Metadata.IAllowCookieRedirectMetadata" /> overrides this no matter the order. When present and not overridden, the cookie authentication handler will prefer using 401 and 403 status codes over redirecting to the login or access denied paths.
interface IDisableHttpMetricsMetadata
A marker interface which can be used to identify metadata that disables HTTP request duration metrics.
interface IDisableValidationMetadata
A marker interface which can be used to identify metadata that disables validation on a given endpoint.
interface IEndpointDescriptionMetadata
Defines a contract used to specify a description in <see cref="P:Microsoft.AspNetCore.Http.Endpoint.Metadata" /> .
interface IEndpointMetadataProvider
Indicates that a type provides a static method that provides <see cref="T:Microsoft.AspNetCore.Http.Endpoint" /> metadata when declared as a parameter type or the returned type of an <see cref="T:Microsoft.AspNetCore.Http.Endpoint" /> route handler delegate.
interface IEndpointParameterMetadataProvider
Indicates that a type provides a static method that provides <see cref="T:Microsoft.AspNetCore.Http.Endpoint" /> metadata when declared as the parameter type of an <see cref="T:Microsoft.AspNetCore.Http.Endpoint" /> route handler delegate.
interface IEndpointSummaryMetadata
Defines a contract used to specify a summary in <see cref="P:Microsoft.AspNetCore.Http.Endpoint.Metadata" /> .
interface IFormOptionsMetadata
Interface marking attributes that specify limits associated with reading a form.
interface IFromBodyMetadata
Interface marking attributes that specify a parameter should be bound using the request body.
interface IFromFormMetadata
Interface marking attributes that specify a parameter should be bound using a form field from the request body.
interface IFromHeaderMetadata
Interface marking attributes that specify a parameter should be bound using the request headers.
interface IFromQueryMetadata
Interface marking attributes that specify a parameter should be bound using the request query string.
interface IFromRouteMetadata
Interface marking attributes that specify a parameter should be bound using route-data from the current request.
interface IFromServiceMetadata
Interface marking attributes that specify a parameter should be bound using request services.
interface IParameterBindingMetadata
Exposes metadata about the parameter binding details associated with a parameter in the endpoints handler.
interface IProducesResponseTypeMetadata
Defines a contract for outline the response type returned from an endpoint.
interface IRequestSizeLimitMetadata
Interface marking attributes that specify the maximum allowed size of the request body.
interface IRouteDiagnosticsMetadata
Interface for specifing diagnostics text for a route.
interface ISkipStatusCodePagesMetadata
Defines a contract used to specify metadata for skipping the StatusCodePage middleware in <see cref="P:Microsoft.AspNetCore.Http.Endpoint.Metadata" /> .
interface ITagsMetadata
Defines a contract used to specify a collection of tags in <see cref="P:Microsoft.AspNetCore.Http.Endpoint.Metadata" /> .

Microsoft.​AspNetCore.​Mvc

class ProblemDetails
A machine-readable format for specifying errors in HTTP API responses based on <see href="https://tools.ietf.org/html/rfc7807" /> .

Microsoft.​AspNetCore.​Routing

class RouteValueDictionary
An <see cref="T:System.Collections.Generic.IDictionary`2" /> type for route values.