@angular/common/http

Implements an HTTP client API for Angular apps that relies on the XMLHttpRequest interface exposed by browsers.

Includes testability features, typed request and response objects, request and response interception, observable APIs, and streamlined error handling.

For usage information, see the HTTP Client guide.

入口点的导出

模块

HttpClientJsonpModule

为支持 JSONP 的 HttpClient 配置依赖注入器。 如果没有该模块,Jsonp 请求就会被发送到后端,然后被后端拒绝。

Configures the dependency injector for HttpClient with supporting services for JSONP. Without this module, Jsonp requests reach the backend with method JSONP, where they are rejected.

HttpClientModule

为支持 XSRF 的 HttpClient 配置依赖注入器。它会被 HttpClientModule 自动导入。

Configures the dependency injector for HttpClient with supporting services for XSRF. Automatically imported by HttpClientModule.

HttpClientXsrfModule

配置 XSRF 保护,以支持外发请求。

Configures XSRF protection support for outgoing requests.

HttpBackend

最后一个 HttpHandler,它将会把该请求通过浏览器的 HTTP API 发到后端。

A final HttpHandler which will dispatch the request via browser HTTP APIs to a backend.

HttpClient

执行 HTTP 请求。

Perform HTTP requests.

HttpErrorResponse

一个用于表示错误或失败的响应对象,或者来自执行请求时发生的错误给出的失败的 HTTP 状态码,或者来自在解析响应对象期间发生的其它错误。

A response that represents an error or failure, either from a non-successful HTTP status, an error while executing the request, or some other failure which occurred during the parsing of the response.

HttpHandler

把一个 HttpRequest 转换成 HttpEvent 组成的流,HttpResponse 就是其中之一。

Transforms an HttpRequest into a stream of HttpEvents, one of which will likely be a HttpResponse.

HttpHeaderResponse

一个部分 HTTP 请求,它只包括状态和响应头数据,但没有响应体。

A partial HTTP response which only includes the status and header data, but no response body.

HttpHeaders

Http 头的不可变集合,惰性解析。

Immutable set of Http headers, with lazy parsing.

HttpParams

HTTP 请求/响应体,用来表示序列化参数,它们的 MIME 类型都是 application/x-www-form-urlencoded

An HTTP request/response body that represents serialized parameters, per the MIME type application/x-www-form-urlencoded.

HttpRequest

一个外发的 HTTP 请求,带有一个可选的类型化的请求体(body)。

An outgoing HTTP request with an optional typed body.

HttpResponse

一个完整的 HTTP 响应对象,包括一个带类型的响应体(如果没返回内容,则为 null)。

A full HTTP response, including a typed response body (which may be null if one was not returned).

HttpResponseBase

HttpResponseHttpHeaderResponse 的共同基类。

Base class for both HttpResponse and HttpHeaderResponse.

HttpUrlEncodingCodec

一个 HttpParameterCodec,它使用 encodeURIComponentdecodeURIComponent 来序列化和解析 URL 参数的 key 和 value。

A HttpParameterCodec that uses encodeURIComponent and decodeURIComponent to serialize and parse URL parameter keys and values.

HttpXhrBackend

An HttpBackend which uses the XMLHttpRequest API to send requests to a backend server.

HttpXsrfTokenExtractor

Retrieves the current XSRF token to use with the next outgoing request.

JsonpClientBackend

HttpBackend that only processes HttpRequest with the JSONP method, by performing JSONP style requests.

JsonpInterceptor

An HttpInterceptor which identifies requests with the method JSONP and shifts them to the JsonpClientBackend.

XhrFactory

A wrapper around the XMLHttpRequest constructor.

结构

HttpDownloadProgressEvent

下载进度事件。

A download progress event.

HttpEventType

不同种类的 HttpEvent 的枚举类型。

Type enumeration for the different kinds of HttpEvent.

HttpInterceptor

拦截 HttpRequest 并处理它们。

Intercepts HttpRequest and handles them.

HttpParameterCodec

一个用来在 URL 中编码和解码参数的编解码器。

A codec for encoding and decoding parameters in URLs.

HttpProgressEvent

Base interface for progress events.

HttpSentEvent

用于表示请求已经发到服务器的事件。 当请求可能被多次接受时很有用,以区分出最终事件流上的重试行为。

An event indicating that the request was sent to the server. Useful when a request may be retried multiple times, to distinguish between retries on the final event stream.

HttpUserEvent

用户定义的事件。

A user-defined event.

类型

HTTP_INTERCEPTORS

A multi-provider token which represents the array of HttpInterceptors that are registered.

HttpEvent

响应流中所有可能出现的事件的联合类型。

Union type for all possible events on the response stream.