nodejs的request文档
时间: 2023-10-24 08:34:03 浏览: 134
Node.js中有一个名为`request`的模块,它允许您发出HTTP / HTTPS请求。以下是使用该模块的基本文档:
## 安装
要安装该模块,请在终端中运行以下命令:
```
npm install request
```
## 发送请求
要发送HTTP / HTTPS请求,请使用`request`函数。以下是一个简单的示例:
```javascript
const request = require('request');
request('https://www.example.com', function (error, response, body) {
if (error) {
console.error(error);
} else {
console.log(body);
}
});
```
上述代码将向https://www.example.com发送请求,并打印响应正文(如果请求成功)。
## 选项
您可以使用`request`函数的选项参数来配置请求。以下是一些常用选项的示例:
- `url`: 请求的URL(字符串)
- `method`: 请求方法(例如`GET`,`POST`,`PUT`等)
- `headers`: 请求头(对象)
- `body`: 请求正文(字符串或对象)
- `json`: 如果请求正文是JSON,则将其设置为`true`(默认为`false`)
- `qs`: 查询字符串参数(对象)
例如:
```javascript
const request = require('request');
const options = {
url: 'https://www.example.com',
method: 'POST',
headers: {
'Content-Type': 'application/json'
},
body: {
name: 'John Doe',
email: 'johndoe@example.com'
},
json: true
};
request(options, function (error, response, body) {
if (error) {
console.error(error);
} else {
console.log(body);
}
});
```
上述代码将向https://www.example.com发送POST请求,请求正文为JSON对象`{name: 'John Doe', email: 'johndoe@example.com'}`。
## 响应
当请求完成时,`request`函数将调用回调函数,并将三个参数传递给它:
- `error`: 如果发生错误,则为错误对象;否则为`null`
- `response`: 响应对象,包括状态码、响应头等
- `body`: 响应正文
例如:
```javascript
const request = require('request');
request('https://www.example.com', function (error, response, body) {
if (error) {
console.error(error);
} else {
console.log(response.statusCode);
console.log(body);
}
});
```
上述代码将向https://www.example.com发送请求,并打印状态码和响应正文(如果请求成功)。
这是使用Node.js中的`request`模块发出HTTP / HTTPS请求的基本文档。有关更多信息,请参阅[官方文档](https://github.com/request/request)。
阅读全文