rely-ons · 天幕运行面 SDK

对外调用动态 API与自定义 API 的轻量依赖，Node.js 与 Java 各一份，配置尽量统一。

📖 完整使用说明见：使用文档.md

• §4 参数获取来源：每个环境变量/参数从哪获取
• §3 安装：npm / Maven Central 或本地 file:
• 鉴权、API 示例、安全与运行时排错见使用文档其余章节

最简配置（三选一环境变量 + 两项必填）

YC_BASE_URL=http://localhost:8081/yc    # 平台根路径，含 /yc
YC_PROJECT_ID=你的项目ID
YC_ACCESS_KEY=ycdk_xxxxxxxx           # 服务配置里生成的接入密钥

本地试调（管理端已开、未配密钥）可加：

YC_INVOKE_SKIP_AUTH=1

安装

公开发布（推荐）

npm install yc-runtime-sdk

<dependency>
  <groupId>team.dream.yc</groupId>
  <artifactId>yc-runtime-sdk</artifactId>
  <version>1.0.0</version>
</dependency>

import { createClientFromEnv } from 'yc-runtime-sdk';

本地开发（未发布时）

见 使用文档 §3：npm install file:... / mvn install。

安装后配置

YC_BASE_URL=http://localhost:8081/yc
YC_PROJECT_ID=你的项目ID
YC_ACCESS_KEY=ycdk_xxxxxxxx

包说明

目录	语言	说明
yc-runtime-sdk	Node.js ≥18	npm：yc-runtime-sdk
yc-runtime-sdk-java	Java 11+	team.dream.yc:yc-runtime-sdk

Node 快速开始

import { createClientFromEnv } from 'yc-runtime-sdk';

const yc = createClientFromEnv();

// 动态 API（modelKey 与平台发布一致，如 products）
const list = await yc.dynamic.list('products', { currentPage: 1, pageSize: 10 });

// 自定义 API（apiKey 与平台发布一致）
const data = await yc.custom.invoke('order_summary', { userId: 1 });

Java 快速开始

YcRuntimeClient yc = YcRuntimeClient.fromEnv();

Map<String, Object> list = yc.dynamicList("products", Map.of("currentPage", 1, "pageSize", 10));
Object data = yc.customInvoke("order_summary", Map.of("userId", 1));

文档

文档	读者
使用文档.md	接入方：安装、配置、API、排错
CHANGELOG.md	版本历史

鉴权说明

• 配置了有效 YC_ACCESS_KEY 时：自动 X-Access-Key 换短期 Token，再 Authorization: Bearer 调用（动态/自定义共用，与平台「服务配置」统一鉴权一致）。
• 动态 API 若平台为 PROJECT_JWT：可在单次调用传入业务用户 JWT，或设置 userJwt 配置项。
• Node 可选 YC_CLIENT_RSA_PRIVATE_KEY：RS256 私钥签 Bearer（与平台 RSA 凭证模式一致）。