文档

材料

材料记录、应用加工属性和资源访问。

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

调试台

将这些请求发送到您自己正在运行的 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 演练.

运营

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

得到	/api/materials	materials.list
邮政	/api/materials	materials.create
得到	/api/materials/{id}	materials.get
放	/api/materials/{id}	materials.update
删除	/api/materials/{id}	materials.remove

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

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

/api/materials

得到 /api/materials # materials.list

需要 Authorization: Bearer <token>.

参数

姓名	在	类型	必需的
搜索	询问	细绳 \| null	选修的
民众	询问	细绳 \| null	选修的

回应

200 数组<对象> application/json

Array<{
  id: string
  name: string
  description: string | null
  properties: unknown
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}>

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

响应示例捕获·200

获取/api/材料

[]

SDK示例

materials.list

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

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

// MaterialsListInput
const result = await client.materials.list({})

curl

获取/api/材料

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

尝试一下

搜索询问民众询问

邮政 /api/materials # materials.create

需要 Authorization: Bearer <token>.

请求正文 · 必填 · application/json

{
  name?: string | null
  description?: string | null
  properties?: unknown | null
  organizationId?: string | null
  isPublic?: boolean | null
}

回应

201 目的 application/json

{
  id: string
  name: string
  description: string | null
  properties: unknown
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

materials.create

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

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

// MaterialsCreateInput
const result = await client.materials.create({
  name: "",
  description: "",
  properties: null,
  organizationId: "",
  isPublic: false
})

curl

POST /api/材料

curl --request POST "${CADCAMFUN_URL}/api/materials" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json

尝试一下

请求正文 application/json

得到 /api/materials/{id} # materials.get

需要 Authorization: Bearer <token>.

参数

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

回应

200 目的 application/json

{
  id: string
  name: string
  description: string | null
  properties: unknown
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
  owner: {
    id: string
    name: string | null
    email: string | null
  } | null
  organization: {
    id: string
    name: string
  } | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

materials.get

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

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

// MaterialsGetInput
const result = await client.materials.get({
  id: "<id>"
})

curl

获取 /api/materials/{id}

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

尝试一下

iD 路径·必填

放 /api/materials/{id} # materials.update

需要 Authorization: Bearer <token>.

参数

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

请求正文 · 必填 · application/json

{
  name?: string | null
  description?: string | null
  properties?: unknown | null
  organizationId?: string | null
  isPublic?: boolean | null
}

回应

200 目的 application/json

{
  id: string
  name: string
  description: string | null
  properties: unknown
  isPublic: boolean
  createdAt: string
  updatedAt: string
  ownerId: string | null
  organizationId: string | null
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

materials.update

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

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

// MaterialsUpdateInput
const result = await client.materials.update({
  id: "<id>",
  name: "",
  description: "",
  properties: null,
  organizationId: "",
  isPublic: false
})

curl

PUT /api/materials/{id}

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

尝试一下

iD 路径·必填

请求正文 application/json

删除 /api/materials/{id} # materials.remove

需要 Authorization: Bearer <token>.

参数

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

回应

200 目的 application/json

{
  message: string
}

400 BadRequestEncoded application/json

BadRequestEncoded

401 UnauthorizedEncoded application/json

UnauthorizedEncoded

403 ForbiddenEncoded application/json

ForbiddenEncoded

404 NotFoundEncoded application/json

NotFoundEncoded

500 InternalErrorEncoded application/json

InternalErrorEncoded

SDK示例

materials.remove

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

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

// MaterialsRemoveInput
const result = await client.materials.remove({
  id: "<id>"
})

curl

删除 /api/materials/{id}

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

尝试一下

iD 路径·必填

模式

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

BadRequestEncoded

{
  _tag: "BadRequest"
  message: string
}

ForbiddenEncoded

{
  _tag: "Forbidden"
  message: string
}

InternalErrorEncoded

{
  _tag: "InternalError"
  message: string
}

NotFoundEncoded

{
  _tag: "NotFound"
  message: string
}

UnauthorizedEncoded

{
  _tag: "Unauthorized"
  message: string
}

呼叫该群组

操作 ID 的形式为 materials.<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` 行。