文档中心

安装 Node.js SDK

最近更新时间：2023.11.13 16:31:30

首次发布时间：2022.06.15 11:55:01

使用火山引擎 Node.js SDK 调用日志服务 API 接口、实现相关功能之前，您需要先安装 Node.js SDK。本文介绍 Node.js SDK 的安装步骤。

前提条件

已创建并获取火山引擎访问密钥 AccessKey。
访问密钥 AccessKey 拥有所有 API 的全部权限。建议您通过 IAM 用户进行 API 相关操作和日常运维。使用 IAM 用户前，主账号需要为 IAM 用户授予日志服务相关资源和操作的权限。

准备开发环境

Node.js SDK 基于 Node.js 环境构建，开始接入前，请先下载并安装 Node.js。下载地址及相关操作请查看 Node.js 官网。

安装 SDK

执行以下命令初始化 SDK，并根据提示进行 npm 初始化配置。

npm init

初始化完成后，npm 会自动创建名为 package.json 的配置文件，文件内容如下：

{
  "name": "nodejs",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC"
}

通过 npm 安装 SDK。

说明

如果使用 npm 遇到网络问题，建议使用指定 npm 镜像。

npm install @volcengine/openapi

执行完成后，@volcengine/openapi 信息已自动填写在 package.json 文件中。文件内容如下：

{
  "name": "nodejs-doc",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "ISC",
  "dependencies": {
    "@volcengine/openapi": "^1.2.2"
  }
}

通过 Express 搭建项目。
本文以使用 Express 搭建项目为例，您也可以选择其他方式搭建 Node.js 项目。

执行以下命令，通过 npm 安装 Express。
安装 Express 的详细说明，请参考 Express官网。
```
npm install express
```
执行以下命令，通过 npm 安装 morgan。
```
npm install morgan
```

创建一个名为 app.js 的文件，并输入以下代码内容。

var express = require('express')
var morgan = require('morgan')
var app = express()
const logger = morgan(function (tokens, req, res) {
  return [
    tokens.method(req, res),
    tokens.url(req, res),
    tokens.status(req, res),
    tokens.res(req, res, 'content-length'), '-',
    tokens['response-time'](req, res), 'ms'
  ].join(' ')
})
app.use(logger)
app.get('/', (req, res) => res.send('Hello World!'))
app.listen(3001, () => console.log('Listening on port 3001!'))

执行以下命令启动项目。
```
node app.js
```
执行完成后，终端会显示以下信息，表示成功启动项目。
```
Listening on port 3001！
```

前提条件

准备开发环境

安装 SDK