新手入门
从安装到第一个项目，快速上手黑料中文网
安装指南
黑料中文网支持多种安装方式，您可以根据自己的需求选择合适的安装方法。
前置条件
- 操作系统：Windows 10+/macOS 10.15+/Linux
- Node.js：v16.0.0 或更高版本
- npm：v8.0.0 或更高版本
使用 npm 安装
推荐使用 npm 进行安装，这是最简单和最常用的方式。
npm install @heilaozhongwen/sdk --save
使用 yarn 安装
如果您使用 yarn 作为包管理器，可以使用以下命令：
yarn add @heilaozhongwen/sdk
使用 CDN 引入
对于前端项目，您也可以直接通过 CDN 引入：
<script src="https://cdn.heilaozhongwen.com/sdk/v2.0.0/index.js"></script>
💡 提示：建议使用包管理器安装，这样可以更好地管理依赖版本。
快速开始
安装完成后，您可以按照以下步骤快速创建第一个项目。
步骤1：初始化项目
首先，创建一个新的项目目录并初始化：
mkdir my-project
cd my-project
npm init -y
步骤2：安装依赖
安装黑料中文网 SDK：
npm install @heilaozhongwen/sdk --save
步骤3：创建入口文件
创建一个 index.js 文件：
const SDK = require('@heilaozhongwen/sdk');
const client = new SDK.Client({
apiKey: 'your-api-key',
endpoint: 'https://api.heilaozhongwen.com'
});
async function main() {
try {
const result = await client.getData({
query: 'example query'
});
console.log('Result:', result);
} catch (error) {
console.error('Error:', error);
}
}
main();
步骤4：运行项目
执行以下命令运行项目：
node index.js
📝 注意：请将 your-api-key 替换为您的实际 API 密钥。
基本概念
在使用黑料中文网之前，了解一些基本概念将帮助您更好地理解产品。
API 密钥
API 密钥是访问黑料中文网服务的凭证。您需要在控制台创建 API 密钥，并在使用 SDK 时配置。
💡 提示：请妥善保管您的 API 密钥，不要泄露给他人。
客户端 (Client)
客户端是与黑料中文网服务交互的主要入口。您需要创建一个客户端实例，并配置必要的参数。
请求 (Request)
请求是向黑料中文网服务发送的操作。每个请求包含操作类型、参数等信息。
响应 (Response)
响应是黑料中文网服务返回的结果。响应包含操作结果、数据等信息。
错误处理
当操作失败时，SDK 会抛出错误。您需要捕获并处理这些错误。
try {
const result = await client.getData(params);
} catch (error) {
console.error('Error code:', error.code);
console.error('Error message:', error.message);
}