配置参数
了解黑料中文网的所有配置参数
基础配置
基础配置是使用黑料中文网 SDK 时必须配置的参数。
apiKey
类型：string
必填：是
说明：您的 API 密钥，用于身份认证。
apiKey: 'your-api-key'
endpoint
类型：string
必填：否
默认值：https://api.heilaozhongwen.com
说明：API 服务端点地址。
endpoint: 'https://api.heilaozhongwen.com'
version
类型：string
必填：否
默认值：v2
说明：API 版本号。
version: 'v2'
timeout
类型：number
必填：否
默认值：30000
说明：请求超时时间，单位为毫秒。
timeout: 30000
高级配置
高级配置用于自定义 SDK 的行为。
cache
类型：object
必填：否
说明：缓存配置。
cache: {
enabled: true, // 是否启用缓存
ttl: 3600, // 缓存时间（秒）
maxSize: 1000 // 最大缓存条数
}
connection
类型：object
必填：否
说明：连接配置。
connection: {
maxConnections: 10, // 最大连接数
keepAlive: true, // 是否保持连接
timeout: 30000 // 连接超时时间（毫秒）
}
logger
类型：object
必填：否
说明：日志配置。
logger: {
level: 'info', // 日志级别: debug, info, warn, error
info: (msg) => console.log(msg),
warn: (msg) => console.warn(msg),
error: (msg) => console.error(msg)
}
retry
类型：object
必填：否
说明：重试配置。
retry: {
enabled: true, // 是否启用重试
maxRetries: 3, // 最大重试次数
delay: 1000, // 重试延迟（毫秒）
backoff: true // 是否指数退避
}
security
类型：object
必填：否
说明：安全配置。
security: {
encrypt: true, // 是否加密传输
verifySSL: true // 是否验证 SSL 证书
}
环境变量
除了在代码中配置，您还可以通过环境变量来配置 SDK。
环境变量列表
- HEILAOZHONGWEN_API_KEY: API 密钥
- HEILAOZHONGWEN_ENDPOINT: API 端点地址
- HEILAOZHONGWEN_VERSION: API 版本
- HEILAOZHONGWEN_TIMEOUT: 请求超时时间
- HEILAOZHONGWEN_CACHE_ENABLED: 是否启用缓存
- HEILAOZHONGWEN_CACHE_TTL: 缓存时间
- HEILAOZHONGWEN_LOG_LEVEL: 日志级别
使用环境变量
在 Node.js 中，可以通过 process.env 读取环境变量：
const client = new SDK.Client({
apiKey: process.env.HEILAOZHONGWEN_API_KEY,
endpoint: process.env.HEILAOZHONGWEN_ENDPOINT,
timeout: parseInt(process.env.HEILAOZHONGWEN_TIMEOUT) || 30000
});
.env 文件
推荐使用 .env 文件管理环境变量：
# .env 文件
HEILAOZHONGWEN_API_KEY=your-api-key
HEILAOZHONGWEN_ENDPOINT=https://api.heilaozhongwen.com
HEILAOZHONGWEN_TIMEOUT=30000
然后使用 dotenv 库加载：
require('dotenv').config();
const client = new SDK.Client({
apiKey: process.env.HEILAOZHONGWEN_API_KEY
});
💡 提示：将 .env 文件添加到 .gitignore 中，避免泄露敏感信息。
配置示例
以下是一个完整的配置示例：
const client = new SDK.Client({
// 基础配置
apiKey: 'your-api-key',
endpoint: 'https://api.heilaozhongwen.com',
version: 'v2',
timeout: 30000,
// 高级配置
cache: {
enabled: true,
ttl: 3600,
maxSize: 1000
},
connection: {
maxConnections: 10,
keepAlive: true,
timeout: 30000
},
logger: {
level: 'info',
info: (msg) => console.log(`[INFO] ${msg}`),
warn: (msg) => console.warn(`[WARN] ${msg}`),
error: (msg) => console.error(`[ERROR] ${msg}`)
},
retry: {
enabled: true,
maxRetries: 3,
delay: 1000,
backoff: true
},
security: {
encrypt: true,
verifySSL: true
}
});