diff --git a/zh-cn/application-dev/reference/apis/js-apis-http.md b/zh-cn/application-dev/reference/apis/js-apis-http.md index 879a70e6a09dcef744013644d58f63ed5f83846f..1276087c311dcea4036bcb15cb04aa0b953b2a4e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-http.md +++ b/zh-cn/application-dev/reference/apis/js-apis-http.md @@ -98,7 +98,7 @@ createHttp(): HttpRequest | 类型 | 说明 | | :---------- | :----------------------------------------------------------- | -| HttpRequest | 返回一个HttpRequest对象，里面包括request、requestInStream、destroy、on和off方法。 | +| HttpRequest | 返回一个HttpRequest对象，里面包括request、destroy、on和off方法。 | **示例：** @@ -110,7 +110,7 @@ let httpRequest = http.createHttp(); ## HttpRequest -HTTP请求任务。在调用HttpRequest的方法前，需要先通过[createHttp()](#httpcreatehttp)创建一个任务。 +HTTP请求任务。在调用HttpRequest的方法前，需要先通过[createHttp()](#httpcreatehttp6)创建一个任务。 ### request6+ @@ -130,7 +130,7 @@ request(url: string, callback: AsyncCallback\):void | 参数名 | 类型 | 必填 | 说明 | | -------- | ---------------------------------------------- | ---- | ----------------------- | | url | string | 是 | 发起网络请求的URL地址。 | -| callback | AsyncCallback\<[HttpResponse](#httpresponse)\> | 是 | 回调函数。 | +| callback | AsyncCallback\<[HttpResponse](#httpresponse6)\> | 是 | 回调函数。 | **错误码：** @@ -208,8 +208,8 @@ request(url: string, options: HttpRequestOptions, callback: AsyncCallback\ | 是 | 回调函数。 | +| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#httprequestoptions6)。 | +| callback | AsyncCallback\<[HttpResponse](#httpresponse6)\> | 是 | 回调函数。 | **错误码：** @@ -303,13 +303,13 @@ request(url: string, options? : HttpRequestOptions): Promise\ | 参数名 | 类型 | 必填 | 说明 | | ------- | ------------------ | ---- | ----------------------------------------------- | | url | string | 是 | 发起网络请求的URL地址。 | -| options | HttpRequestOptions | 否 | 参考[HttpRequestOptions](#httprequestoptions)。 | +| options | HttpRequestOptions | 否 | 参考[HttpRequestOptions](#httprequestoptions6)。 | **返回值：** | 类型 | 说明 | | :------------------------------------- | :-------------------------------- | -| Promise<[HttpResponse](#httpresponse)> | 以Promise形式返回发起请求的结果。 | +| Promise<[HttpResponse](#httpresponse6)> | 以Promise形式返回发起请求的结果。 | **错误码：** @@ -400,251 +400,6 @@ let httpRequest = http.createHttp(); httpRequest.destroy(); ``` -### requestInStream10+ - -requestInStream(url: string, callback: AsyncCallback\): void - -根据URL地址，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**：SystemCapability.Communication.NetStack - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------------- | ---- | ----------------------------------------------- | -| url | string | 是 | 发起网络请求的URL地址。 | -| callback | AsyncCallback\<[number](#responsecode)\> | 是 | 回调函数。 | - -**错误码：** - -| 错误码ID | 错误信息 | -|---------|-------------------------------------------------------| -| 401 | Parameter error. | -| 201 | Permission denied. | -| 2300001 | Unsupported protocol. | -| 2300003 | URL using bad/illegal format or missing URL. | -| 2300005 | Couldn't resolve proxy name. | -| 2300006 | Couldn't resolve host name. | -| 2300007 | Couldn't connect to server. | -| 2300008 | Weird server reply. | -| 2300009 | Access denied to remote resource. | -| 2300016 | Error in the HTTP2 framing layer. | -| 2300018 | Transferred a partial file. | -| 2300023 | Failed writing received data to disk/application. | -| 2300025 | Upload failed. | -| 2300026 | Failed to open/read local data from file/application. | -| 2300027 | Out of memory. | -| 2300028 | Timeout was reached. | -| 2300047 | Number of redirects hit maximum amount. | -| 2300052 | Server returned nothing (no headers, no data). | -| 2300055 | Failed sending data to the peer. | -| 2300056 | Failure when receiving data from the peer. | -| 2300058 | Problem with the local SSL certificate. | -| 2300059 | Couldn't use specified SSL cipher. | -| 2300060 | SSL peer certificate or SSH remote key was not OK. | -| 2300061 | Unrecognized or bad HTTP Content or Transfer-Encoding.| -| 2300063 | Maximum file size exceeded. | -| 2300070 | Disk full or allocation exceeded. | -| 2300073 | Remote file already exists. | -| 2300077 | Problem with the SSL CA cert (path? access rights?). | -| 2300078 | Remote file not found. | -| 2300094 | An authentication function returned an error. | -| 2300999 | Unknown Other Error. | - -> **错误码说明：** -> 以上错误码的详细介绍参见[HTTP错误码](../errorcodes/errorcode-net-http.md)。 -> HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考curl错误码:https://curl.se/libcurl/c/libcurl-errors.html - -**示例：** - -```ts -import http from '@ohos.net.http'; -import { BusinessError } from '@ohos.base'; - -let httpRequest = http.createHttp(); -httpRequest.requestInStream("EXAMPLE_URL", (err: BusinessError, data: number) => { - if (!err) { - console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data)); - } else { - console.info("requestInStream ERROR : err = " + JSON.stringify(err)); - } -}) -``` - -### requestInStream10+ - -requestInStream(url: string, options: HttpRequestOptions, callback: AsyncCallback\): void - -根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**：SystemCapability.Communication.NetStack - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| -------- | ---------------------------------------------- | ---- | ----------------------------------------------- | -| url | string | 是 | 发起网络请求的URL地址。 | -| options | HttpRequestOptions | 是 | 参考[HttpRequestOptions](#httprequestoptions)。 | -| callback | AsyncCallback\<[number](#responsecode)\> | 是 | 回调函数。 | - -**错误码：** - -| 错误码ID | 错误信息 | -|---------|-------------------------------------------------------| -| 401 | Parameter error. | -| 201 | Permission denied. | -| 2300001 | Unsupported protocol. | -| 2300003 | URL using bad/illegal format or missing URL. | -| 2300005 | Couldn't resolve proxy name. | -| 2300006 | Couldn't resolve host name. | -| 2300007 | Couldn't connect to server. | -| 2300008 | Weird server reply. | -| 2300009 | Access denied to remote resource. | -| 2300016 | Error in the HTTP2 framing layer. | -| 2300018 | Transferred a partial file. | -| 2300023 | Failed writing received data to disk/application. | -| 2300025 | Upload failed. | -| 2300026 | Failed to open/read local data from file/application. | -| 2300027 | Out of memory. | -| 2300028 | Timeout was reached. | -| 2300047 | Number of redirects hit maximum amount. | -| 2300052 | Server returned nothing (no headers, no data). | -| 2300055 | Failed sending data to the peer. | -| 2300056 | Failure when receiving data from the peer. | -| 2300058 | Problem with the local SSL certificate. | -| 2300059 | Couldn't use specified SSL cipher. | -| 2300060 | SSL peer certificate or SSH remote key was not OK. | -| 2300061 | Unrecognized or bad HTTP Content or Transfer-Encoding.| -| 2300063 | Maximum file size exceeded. | -| 2300070 | Disk full or allocation exceeded. | -| 2300073 | Remote file already exists. | -| 2300077 | Problem with the SSL CA cert (path? access rights?). | -| 2300078 | Remote file not found. | -| 2300094 | An authentication function returned an error. | -| 2300999 | Unknown Other Error. | - -> **错误码说明：** -> 以上错误码的详细介绍参见[HTTP错误码](../errorcodes/errorcode-net-http.md)。 -> HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考curl错误码:https://curl.se/libcurl/c/libcurl-errors.html - -**示例：** - -```ts -import http from '@ohos.net.http'; -import { BusinessError } from '@ohos.base'; - -class Header { - public contentType: string; - - constructor(contentType: string) { - this.contentType = contentType; - } -} - -let httpRequest = http.createHttp(); -httpRequest.requestInStream("EXAMPLE_URL", (err: BusinessError , data: number) => { - if (!err) { - console.info("requestInStream OK! ResponseCode is " + JSON.stringify(data)); - } else { - console.info("requestInStream ERROR : err = " + JSON.stringify(err)); - } -}) -``` - -### requestInStream10+ - -requestInStream(url: string, options? : HttpRequestOptions): Promise\ - -根据URL地址，发起HTTP网络请求并返回流式响应，使用Promise方式作为异步方法。 - -**需要权限**：ohos.permission.INTERNET - -**系统能力**：SystemCapability.Communication.NetStack - -**参数：** - -| 参数名 | 类型 | 必填 | 说明 | -| ------- | ------------------ | ---- | ----------------------------------------------- | -| url | string | 是 | 发起网络请求的URL地址。 | -| options | HttpRequestOptions | 否 | 参考[HttpRequestOptions](#httprequestoptions)。 | - -**返回值：** - -| 类型 | 说明 | -| :------------------------------------- | :-------------------------------- | -| Promise\<[number](#responsecode)\> | 以Promise形式返回发起请求的结果。 | - -**错误码：** - -| 错误码ID | 错误信息 | -|---------|-------------------------------------------------------| -| 401 | Parameter error. | -| 201 | Permission denied. | -| 2300001 | Unsupported protocol. | -| 2300003 | URL using bad/illegal format or missing URL. | -| 2300005 | Couldn't resolve proxy name. | -| 2300006 | Couldn't resolve host name. | -| 2300007 | Couldn't connect to server. | -| 2300008 | Weird server reply. | -| 2300009 | Access denied to remote resource. | -| 2300016 | Error in the HTTP2 framing layer. | -| 2300018 | Transferred a partial file. | -| 2300023 | Failed writing received data to disk/application. | -| 2300025 | Upload failed. | -| 2300026 | Failed to open/read local data from file/application. | -| 2300027 | Out of memory. | -| 2300028 | Timeout was reached. | -| 2300047 | Number of redirects hit maximum amount. | -| 2300052 | Server returned nothing (no headers, no data). | -| 2300055 | Failed sending data to the peer. | -| 2300056 | Failure when receiving data from the peer. | -| 2300058 | Problem with the local SSL certificate. | -| 2300059 | Couldn't use specified SSL cipher. | -| 2300060 | SSL peer certificate or SSH remote key was not OK. | -| 2300061 | Unrecognized or bad HTTP Content or Transfer-Encoding.| -| 2300063 | Maximum file size exceeded. | -| 2300070 | Disk full or allocation exceeded. | -| 2300073 | Remote file already exists. | -| 2300077 | Problem with the SSL CA cert (path? access rights?). | -| 2300078 | Remote file not found. | -| 2300094 | An authentication function returned an error. | -| 2300999 | Unknown Other Error. | - -> **错误码说明：** -> 以上错误码的详细介绍参见[HTTP错误码](../errorcodes/errorcode-net-http.md)。 -> HTTP 错误码映射关系：2300000 + curl错误码。更多常用错误码，可参考： - -**示例：** - -```ts -import http from '@ohos.net.http'; - -class Header { - public contentType: string; - - constructor(contentType: string) { - this.contentType = contentType; - } -} - -let httpRequest = http.createHttp(); -let promise = httpRequest.request("EXAMPLE_URL", { - method: http.RequestMethod.GET, - connectTimeout: 60000, - readTimeout: 60000, - header: new Header('application/json') -}); -promise.then((data: http.HttpResponse) => { - console.info("requestInStream OK!" + JSON.stringify(data)); -}).catch((err: Error) => { - console.info("requestInStream ERROR : err = " + JSON.stringify(err)); -}); -``` - ### on('headerReceive')(deprecated) on(type: 'headerReceive', callback: AsyncCallback\): void @@ -965,7 +720,7 @@ httpRequest.off('dataReceiveProgress'); | 名称 | 类型 | 必填 | 说明 | | -------------- | --------------------------------------------- | ---- | ------------------------------------------------------------ | -| method | [RequestMethod](#requestmethod) | 否 | 请求方式，默认为GET。 | +| method | [RequestMethod](#requestmethod6) | 否 | 请求方式，默认为GET。 | | extraData | string6+ \| Object6+ \| ArrayBuffer8+ | 否 | 发送请求的额外数据，默认无此字段。
当HTTP请求为POST、PUT等方法时，此字段为HTTP请求的content，以UTF-8编码形式作为请求体。当'Content-Type'为'application/x-www-form-urlencoded'时，请求提交的信息主体数据应在key和value进行URL转码后按照键值对"key1=value1&key2=value2&key3=value3"的方式进行编码，该字段对应的类型通常为String；当'Content-Type'为'text/xml'时，该字段对应的类型通常为String；当'Content-Type'为'application/json'时，该字段对应的类型通常为Object；当'Content-Type'为'application/octet-stream'时，该字段对应的类型通常为ArrayBuffer；当'Content-Type'为'multipart/form-data'且需上传的字段为文件时，该字段对应的类型通常为ArrayBuffer。以上信息仅供参考，并可能根据具体情况有所不同。
- 当HTTP请求为GET、OPTIONS、DELETE、TRACE、CONNECT等方法时，此字段为HTTP请求参数的补充。开发者需传入Encode编码后的string类型参数，Object类型的参数无需预编码，参数内容会拼接到URL中进行发送；ArrayBuffer类型的参数不会做拼接处理。 | | [expectDataType9+](#result) | [HttpDataType](#httpdatatype9) | 否 | 指定返回数据的类型，默认无此字段。如果设置了此参数，系统将优先返回指定的类型。 | | usingCache9+ | boolean | 否 | 是否使用缓存，默认为true。 | @@ -1048,7 +803,7 @@ request方法回调函数的返回值类型。 | -------------------- | -------------------------------------------- | ---- | ------------------------------------------------------------ | | [result](#expectDataType) | string6+ \| Objectdeprecated 8+ \| ArrayBuffer8+ | 是 | HTTP请求根据响应头中Content-type类型返回对应的响应格式内容，若HttpRequestOptions无expectDataType字段，按如下规则返回：
- application/json：返回JSON格式的字符串；
- application/octet-stream：ArrayBuffer；
- image：ArrayBuffer；
- 其他：string。
若HttpRequestOption有expectDataType字段，开发者需传入与服务器返回类型相同的数据类型。 | | resultType9+ | [HttpDataType](#httpdatatype9) | 是 | 返回值类型。 | -| responseCode | [ResponseCode](#responsecode) \| number | 是 | 回调函数执行成功时，此字段为[ResponseCode](#responsecode)。若执行失败，错误码将会从AsyncCallback中的err字段返回。 | +| responseCode | [ResponseCode](#responsecode6) \| number | 是 | 回调函数执行成功时，此字段为[ResponseCode](#responsecode6)。若执行失败，错误码将会从AsyncCallback中的err字段返回。 | | header | Object | 是 | 发起HTTP请求返回来的响应头。当前返回的是JSON格式字符串，如需具体字段内容，需开发者自行解析。常见字段及解析方式如下：
- content-type：header['content-type']；
- status-line：header['status-line']；
- date：header.date/header['date']；
- server：header.server/header['server']； | | cookies8+ | string | 是 | 服务器返回的 cookies。 |