文档

键值存储

具有前缀列表和每键操作的 JSON 兼容首选项和上下文条目。

从英文自动翻译。查看英文原文

调试台

将这些请求发送到您自己正在运行的 sidecar。值保留在此浏览器中。

未连接

基本网址不记名令牌 选修的 会话令牌 选修的

这是如何运作的

sidecar 侦听启动时选择的环回端口并将其打印在其中 ready 线;使用该 URL 和 CADCAMFUN_TOKEN 它是从开始的。请求直接从该页面发送到该地址。

sidecar 仅将 CORS 标头发送到 Tauri 源并发送到 http://localhost 或 http://127.0.0.1 在任何端口上。浏览器会阻止托管文档的响应，因此请在本地运行文档（bun run dev 中 packages/web) 使用游乐场，或将请求复制为curl。要在不接触真实数据的情况下进行实验，请使用以下命令启动 sidecar CADCAMFUN_DATA_DIR 指向一个一次性目录 - 请参阅 aPI 演练.

运营

4 个端点，位于 kv 组，由 sidecar 自己生成开放API文档。受保护的操作需要 Authorization: Bearer $CADCAMFUN_TOKEN;看验证。行为和限制在子系统指南.

得到	/api/kv	kv.list
得到	/api/kv/{key}	kv.get
放	/api/kv/{key}	kv.set
删除	/api/kv/{key}	kv.remove

3D 中的键值存储操作拖动进行轨道旋转·滚动进行缩放·右键拖动进行平移

每个操作一个块 (4)，按此页面的每个资源部分堆叠，并按方法着色：绿色 GET、橙色 POST、蓝色 PUT、紫色 PATCH、红色 DELETE。在构建时从 OpenAPI 文档生成。

/api/kv

得到 /api/kv # kv.list

需要 Authorization: Bearer <token>.

参数

姓名	在	类型	必需的
前缀	询问	细绳 \| null	选修的

回应

200 目的 application/json

{
  entries: Array<{
    key: string
    value: unknown
    updatedAt: string
  }>
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

响应示例捕获·200

获取/api/kv

{
  "entries": []
}

SDK示例

kv.list

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// KvListInput
const result = await client.kv.list({})

curl

获取/api/kv

curl --request GET "${CADCAMFUN_URL}/api/kv" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

尝试一下

前缀询问

得到 /api/kv/{key} # kv.get

需要 Authorization: Bearer <token>.

参数

姓名	在	类型	必需的
钥匙	小路	细绳	必需的

回应

200 目的 application/json

{
  key: string
  value: unknown
  updatedAt: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

kv.get

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// KvGetInput
const result = await client.kv.get({
  key: "<key>"
})

curl

获取 /api/kv/{key}

curl --request GET "${CADCAMFUN_URL}/api/kv/<key>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

尝试一下

钥匙 路径·必填

放 /api/kv/{key} # kv.set

需要 Authorization: Bearer <token>.

参数

姓名	在	类型	必需的
钥匙	小路	细绳	必需的

请求正文 · 必填 · application/json

{
  value: unknown
}

回应

200 目的 application/json

{
  key: string
  value: unknown
  updatedAt: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

kv.set

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// KvSetInput
const result = await client.kv.set({
  key: "<key>",
  value: null
})

curl

PUT /api/kv/{key}

curl --request PUT "${CADCAMFUN_URL}/api/kv/<key>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

尝试一下

钥匙 路径·必填

请求正文 application/json

删除 /api/kv/{key} # kv.remove

需要 Authorization: Bearer <token>.

参数

姓名	在	类型	必需的
钥匙	小路	细绳	必需的

回应

200 目的 application/json

{
  message: string
}

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

kv.remove

import { CadCam } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

// KvRemoveInput
const result = await client.kv.remove({
  key: "<key>"
})

curl

删除 /api/kv/{key}

curl --request DELETE "${CADCAMFUN_URL}/api/kv/<key>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"

尝试一下

钥匙 路径·必填

模式

可从该组的参数、主体和响应访问命名模式。一个 ? 标记可选字段； | null 标记可能存在空值的字段。

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

呼叫该群组

操作 ID 的形式为 kv.<name>。生成的Promise SDK（@cadcamfun/api/sdk）将其中大部分暴露为 client.<namespace>.<method>(input)，在哪里 input 是路径参数和主体字段的一个平面对象；每张卡的 SDK 示例显示了确切的访问器和输入类型。不会生成分段上传、二进制或 JavaScript 响应以及原始 Webhook；这些卡片显示 fetch 改为。

Promise SDK 的错误

import { CadCam, ClientError } from "@cadcamfun/api/sdk"

const client = CadCam.make({
  baseUrl: process.env.CADCAMFUN_URL!,
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})

try {
  await client.projects.list()
} catch (error) {
  if (error instanceof ClientError) {
    // Transport | UnexpectedStatus | UnsupportedContentType | MalformedResponse | SseEventTooLarge
  } else {
    // a declared error body: switch on error._tag
  }
}

故障排除

症状	可能的原因	使固定
每次调用 401	上次启动的令牌或丢失 `Bearer` 前缀	发送 `Authorization: Bearer <token>` 使用边车启动时的令牌。
在任何事情发生之前的 400	主体或参数与架构不匹配	将有效负载与卡上的请求架构进行比较。
在别处可见的记录上出现 403 或 404	代理账户不同	发送正确的 `x-session-token`，或使用拥有该记录的本地配置文件。
409	状态冲突，例如重复的名称或过时的分支头	重新读取资源并使用当前数据重试。
尝试显示“被 CORS 阻止”	这些文档是从非环回源提供的	在本地运行文档或将请求复制为curl。
连接被拒绝	Sidecar 在新端口上重新启动	从新读取端口 `ready` 行。