Appearance
yc-runtime-sdk
天幕动态 API + 自定义 API Node.js 客户端(ESM,Node ≥18)。
完整说明(鉴权、示例、排错):../使用文档.md
安装
详细步骤见 使用文档 §3.1。
在业务后端根目录执行(按相对路径调整):
bash
# 示例:test-projects/example-1/backend
npm install file:../../../rely-ons/yc-runtime-sdk
# pnpm / yarn
# pnpm add file:../../../rely-ons/yc-runtime-sdkRSA 私钥模式(可选):
bash
npm install jsonwebtoken公开发布:npm publish --access public。
验证:import { createClient } from 'yc-runtime-sdk' 无报错即可。
环境变量(推荐)
| 变量 | 必填 | 说明 |
|---|---|---|
YC_BASE_URL | 是 | 如 http://localhost:8081/yc |
YC_PROJECT_ID | 是 | 项目 ID |
YC_ACCESS_KEY | 生产建议 | 服务配置中的接入密钥 |
YC_INVOKE_SKIP_AUTH | 否 | 1 时本地试调跳过鉴权 |
YC_CLIENT_RSA_PRIVATE_KEY | 否 | 动态 API RSA 模式私钥 PEM |
YC_USER_JWT | 否 | 动态 API 使用业务 JWT 时的默认值 |
代码
javascript
import { createClientFromEnv, createClient } from 'yc-runtime-sdk';
// 方式一:环境变量
const yc = createClientFromEnv();
// 方式二:显式配置
const yc2 = createClient({
baseUrl: 'http://localhost:8081/yc',
projectId: 'xxx',
accessKey: 'ycdk_...',
});
const products = await yc.dynamic.list('products', { currentPage: 1, pageSize: 20 });
const one = await yc.dynamic.get('products', 1);
await yc.dynamic.create('products', { name: 'A' });
await yc.dynamic.put('products', 1, { name: 'B' });
await yc.dynamic.delete('products', 1);
const summary = await yc.custom.invoke('my_api_key', { foo: 'bar' });API
yc.dynamic.list(modelKey, body, userJwt?)yc.dynamic.get / create / put / deleteyc.dynamic.fetch(modelKey, pathSuffix, { method, body, userJwt })yc.custom.invoke(apiKey, body, { method?, headers? })