跳到内容
CADCAMFUN
文档

文档

插件

插件注册表、包安装、配置、启用/禁用以及提供插件资源。

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

调试台

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

运营

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

邮政 /api/plugins/install plugins.install
得到 /api/plugins/bootstrap.js plugins.bootstrap
得到 /api/plugins/serve plugins.serve
得到 /api/plugins plugins.list
得到 /api/plugins/{id} plugins.get
删除 /api/plugins/{id} plugins.uninstall
得到 /api/plugins/{id}/config plugins.getConfig
邮政 /api/plugins/{id}/config plugins.setConfig
放 /api/plugins/{id}/config plugins.updateConfig
邮政 /api/plugins/{id}/enable plugins.enable
邮政 /api/plugins/{id}/disable plugins.disable
放 /api/plugins/{id}/update plugins.update
修补 /api/plugins/{id}/update plugins.patch
得到 /api/plugins/registry plugins.registry
得到 /api/plugins/registry/{id} plugins.registryGet
得到 /api/plugins/registry/search plugins.registrySearch
3D 中的插件操作 拖动进行轨道旋转·滚动进行缩放·右键拖动进行平移
每个操作一个块 (16)，按此页面的每个资源部分堆叠，并按方法着色：绿色 GET、橙色 POST、蓝色 PUT、紫色 PATCH、红色 DELETE。在构建时从 OpenAPI 文档生成。

/api/plugins/install

邮政 /api/plugins/install # plugins.install

需要 Authorization: Bearer <token>.

请求正文 · 必需 · multipart/form-data
{
  file: string[]
}
回应
201 目的 application/json 
{
  message: string
  plugin: {
    id: string
    manifest: {
      id: string
      name: string
      version: string
      description: string
      author: string
      repository?: string | null
      license?: string | null
      icon?: string | null
      main: string
      engines: {
        cadcam: string
      }
      permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
      dependencies?: {
        [key: string]: string
      } | null
      contributes?: {
        sidebar?: {
          title: string
          icon: string
          entry: string
        } | null
        commands?: Array<{
          id: string
          title: string
          icon?: string | null
          keybinding?: string | null
        }> | null
        menus?: {
          toolbar?: Array<{
            command: string
            group?: string | null
            when?: string | null
            priority?: number | "Infinity" | "-Infinity" | "NaN" | null
          }> | null
          contextMenu?: Array<{
            command: string
            group?: string | null
        } | null
        propertyPanel?: Array<{
          id: string
          title: string
          entry: string
          appliesTo?: string | null
        themes?: Array<{
          id: string
          label: string
          path: string
        }> | null
      } | null
      configuration?: {
        properties: {
          [key: string]: {
            type: string
            default?: unknown | null
            description?: string | null
            enum?: unknown[] | null
            minimum?: number | "Infinity" | "-Infinity" | "NaN" | null
            maximum?: number | null
            pattern?: string | null
          }
        }
      } | null
    }
    state: "none" | "installed" | "enabled" | "disabled" | "loaded" | "activated" | "deactivated" | "error"
    enabled: boolean
    version: string
    installedAt: string
    updatedAt: string
    config?: object | null
    configurationId?: string | null
    errorCount: number | "Infinity" | "-Infinity" | "NaN"
    lastError?: string | null
  }
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
409 PluginConflictEncoded application/json 
PluginConflictEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
获取示例
plugins.install 
// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/plugins/install`, {
  method: "POST",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})
curl
POST /api/插件/安装 
curl --request POST "${CADCAMFUN_URL}/api/plugins/install" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: multipart/form-data" \
  --data-binary @request-body
尝试一下

此操作采用 multipart/form-data；使用curl 或fetch 示例。

/api/plugins/bootstrap.js

得到 /api/plugins/bootstrap.js # plugins.bootstrap

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 询问 细绳 必需的
回应
200 细绳 application/javascript 
string
400 细绳 application/javascript 
string
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 细绳 application/javascript 
string
500 细绳 application/javascript 
string
获取示例
plugins.bootstrap 
// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/plugins/bootstrap.js`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})
curl
获取/api/plugins/bootstrap.js 
curl --request GET "${CADCAMFUN_URL}/api/plugins/bootstrap.js?id=<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下

/api/plugins/serve

得到 /api/plugins/serve # plugins.serve

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 询问 细绳 必需的
文件 询问 细绳 必需的
回应
200 细绳 application/octet-stream 
string
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
获取示例
plugins.serve 
// Not generated in the Promise SDK (multipart, binary or raw body): call it with fetch.
const response = await fetch(`${process.env.CADCAMFUN_URL}/api/plugins/serve`, {
  method: "GET",
  headers: { authorization: `Bearer ${process.env.CADCAMFUN_TOKEN}` },
})
curl
获取/api/插件/服务 
curl --request GET "${CADCAMFUN_URL}/api/plugins/serve?id=<id>&file=<file>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下

/api/plugins

得到 /api/plugins # plugins.list

需要 Authorization: Bearer <token>.

回应
200 数组<对象> application/json 
Array<{
  id: string
  manifest: {
    id: string
    name: string
    version: string
    description: string
    author: string
    repository?: string | null
    license?: string | null
    icon?: string | null
    main: string
    engines: {
      cadcam: string
    }
    permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
    dependencies?: {
      [key: string]: string
    } | null
    contributes?: {
      sidebar?: {
        title: string
        icon: string
        entry: string
      } | null
      commands?: Array<{
        id: string
        title: string
        icon?: string | null
        keybinding?: string | null
      }> | null
      menus?: {
        toolbar?: Array<{
          command: string
          group?: string | null
          when?: string | null
          priority?: number | "Infinity" | "-Infinity" | "NaN" | null
        }> | null
        contextMenu?: Array<{
          command: string
          group?: string | null
      } | null
      propertyPanel?: Array<{
        id: string
        title: string
        entry: string
        appliesTo?: string | null
      themes?: Array<{
        id: string
        label: string
        path: string
      }> | null
    } | null
    configuration?: {
      properties: {
        [key: string]: {
          type: string
          default?: unknown | null
          description?: string | null
          enum?: unknown[] | null
          minimum?: number | "Infinity" | "-Infinity" | "NaN" | null
          maximum?: number | null
          pattern?: string | null
        }
      }
    } | null
  }
  state: "none" | "installed" | "enabled" | "disabled" | "loaded" | "activated" | "deactivated" | "error"
  enabled: boolean
  version: string
  installedAt: string
  updatedAt: string
  config?: object | null
  configurationId?: string | null
  errorCount: number | "Infinity" | "-Infinity" | "NaN"
  lastError?: string | null
}>
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
响应示例 捕获·200
获取/api/插件 
[]
SDK示例
plugins.list 
import { CadCam } from "@cadcamfun/api/sdk"

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

// no input
const result = await client.plugins.list()
curl
获取/api/插件 
curl --request GET "${CADCAMFUN_URL}/api/plugins" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
得到 /api/plugins/{id} # plugins.get

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
回应
200 目的 application/json 
{
  id: string
  manifest: {
    id: string
    name: string
    version: string
    description: string
    author: string
    repository?: string | null
    license?: string | null
    icon?: string | null
    main: string
    engines: {
      cadcam: string
    }
    permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
    dependencies?: {
      [key: string]: string
    } | null
    contributes?: {
      sidebar?: {
        title: string
        icon: string
        entry: string
      } | null
      commands?: Array<{
        id: string
        title: string
        icon?: string | null
        keybinding?: string | null
      }> | null
      menus?: {
        toolbar?: Array<{
          command: string
          group?: string | null
          when?: string | null
          priority?: number | "Infinity" | "-Infinity" | "NaN" | null
        }> | null
        contextMenu?: Array<{
          command: string
          group?: string | null
      } | null
      propertyPanel?: Array<{
        id: string
        title: string
        entry: string
        appliesTo?: string | null
      themes?: Array<{
        id: string
        label: string
        path: string
      }> | null
    } | null
    configuration?: {
      properties: {
        [key: string]: {
          type: string
          default?: unknown | null
          description?: string | null
          enum?: unknown[] | null
          minimum?: number | "Infinity" | "-Infinity" | "NaN" | null
          maximum?: number | null
          pattern?: string | null
        }
      }
    } | null
  }
  state: "none" | "installed" | "enabled" | "disabled" | "loaded" | "activated" | "deactivated" | "error"
  enabled: boolean
  version: string
  installedAt: string
  updatedAt: string
  config?: object | null
  configurationId?: string | null
  errorCount: number | "Infinity" | "-Infinity" | "NaN"
  lastError?: string | null
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.get 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsGetInput
const result = await client.plugins.get({
  id: "<id>"
})
curl
获取 /api/plugins/{id} 
curl --request GET "${CADCAMFUN_URL}/api/plugins/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
删除 /api/plugins/{id} # plugins.uninstall

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
回应
200 目的 application/json 
{
  message: string
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.uninstall 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsUninstallInput
const result = await client.plugins.uninstall({
  id: "<id>"
})
curl
删除 /api/plugins/{id} 
curl --request DELETE "${CADCAMFUN_URL}/api/plugins/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
得到 /api/plugins/{id}/config # plugins.getConfig

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
回应
200 目的 application/json 
object
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.getConfig 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsGetConfigInput
const result = await client.plugins.getConfig({
  id: "<id>"
})
curl
获取 /api/plugins/{id}/config 
curl --request GET "${CADCAMFUN_URL}/api/plugins/<id>/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
邮政 /api/plugins/{id}/config # plugins.setConfig

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
请求正文 · 必填 · application/json
object
回应
200 目的 application/json 
{
  message: string
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.setConfig 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsSetConfigInput
const result = await client.plugins.setConfig({
  id: "<id>"
})
curl
POST /api/plugins/{id}/config 
curl --request POST "${CADCAMFUN_URL}/api/plugins/<id>/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json
尝试一下
放 /api/plugins/{id}/config # plugins.updateConfig

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
请求正文 · 必填 · application/json
object
回应
200 目的 application/json 
{
  message: string
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.updateConfig 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsUpdateConfigInput
const result = await client.plugins.updateConfig({
  id: "<id>"
})
curl
PUT /api/plugins/{id}/config 
curl --request PUT "${CADCAMFUN_URL}/api/plugins/<id>/config" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json
尝试一下
邮政 /api/plugins/{id}/enable # plugins.enable

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
回应
200 目的 application/json 
{
  message: string
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.enable 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsEnableInput
const result = await client.plugins.enable({
  id: "<id>"
})
curl
POST /api/plugins/{id}/enable 
curl --request POST "${CADCAMFUN_URL}/api/plugins/<id>/enable" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
邮政 /api/plugins/{id}/disable # plugins.disable

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
回应
200 目的 application/json 
{
  message: string
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.disable 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsDisableInput
const result = await client.plugins.disable({
  id: "<id>"
})
curl
POST /api/plugins/{id}/disable 
curl --request POST "${CADCAMFUN_URL}/api/plugins/<id>/disable" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
放 /api/plugins/{id}/update # plugins.update

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
请求正文 · 必填 · application/json
{
  manifest?: {
    id: string
    name: string
    version: string
    description: string
    author: string
    repository?: string | null
    license?: string | null
    icon?: string | null
    main: string
    engines: {
      cadcam: string
    }
    permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
    dependencies?: {
      [key: string]: string
    } | null
    contributes?: {
      sidebar?: {
        title: string
        icon: string
        entry: string
      } | null
      commands?: Array<{
        id: string
        title: string
        icon?: string | null
        keybinding?: string | null
      }> | null
      menus?: {
        toolbar?: Array<{
          command: string
          group?: string | null
          when?: string | null
          priority?: number | "Infinity" | "-Infinity" | "NaN" | null
        }> | null
        contextMenu?: Array<{
          command: string
          group?: string | null
      } | null
      propertyPanel?: Array<{
        id: string
        title: string
        entry: string
        appliesTo?: string | null
      themes?: Array<{
        id: string
        label: string
        path: string
      }> | null
    } | null
    configuration?: {
      properties: {
        [key: string]: {
          type: string
          default?: unknown | null
          description?: string | null
          enum?: unknown[] | null
          minimum?: number | null
          maximum?: number | null
          pattern?: string | null
        }
      }
    } | null
  } | null
  config?: object | null
}
回应
200 目的 application/json 
{
  id: string
  manifest: {
    id: string
    name: string
    version: string
    description: string
    author: string
    repository?: string | null
    license?: string | null
    icon?: string | null
    main: string
    engines: {
      cadcam: string
    }
    permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
    dependencies?: {
      [key: string]: string
    } | null
    contributes?: {
      sidebar?: {
        title: string
        icon: string
        entry: string
      } | null
      commands?: Array<{
        id: string
        title: string
        icon?: string | null
        keybinding?: string | null
      }> | null
      menus?: {
        toolbar?: Array<{
          command: string
          group?: string | null
          when?: string | null
          priority?: number | "Infinity" | "-Infinity" | "NaN" | null
        }> | null
        contextMenu?: Array<{
          command: string
          group?: string | null
      } | null
      propertyPanel?: Array<{
        id: string
        title: string
        entry: string
        appliesTo?: string | null
      themes?: Array<{
        id: string
        label: string
        path: string
      }> | null
    } | null
    configuration?: {
      properties: {
        [key: string]: {
          type: string
          default?: unknown | null
          description?: string | null
          enum?: unknown[] | null
          minimum?: number | "Infinity" | "-Infinity" | "NaN" | null
          maximum?: number | null
          pattern?: string | null
        }
      }
    } | null
  }
  state: "none" | "installed" | "enabled" | "disabled" | "loaded" | "activated" | "deactivated" | "error"
  enabled: boolean
  version: string
  installedAt: string
  updatedAt: string
  config?: object | null
  configurationId?: string | null
  errorCount: number | "Infinity" | "-Infinity" | "NaN"
  lastError?: string | null
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.update 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsUpdateInput
const result = await client.plugins.update({
  id: "<id>",
  manifest: {
    id: "",
    name: "",
    version: "",
    description: "",
    author: "",
    main: "",
    engines: {
      cadcam: ""
    },
    permissions: [
      "model:read"
    ]
  },
  config: {}
})
curl
PUT /api/plugins/{id}/update 
curl --request PUT "${CADCAMFUN_URL}/api/plugins/<id>/update" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json
尝试一下
修补 /api/plugins/{id}/update # plugins.patch

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
请求正文 · 必填 · application/json
{
  manifest?: {
    id: string
    name: string
    version: string
    description: string
    author: string
    repository?: string | null
    license?: string | null
    icon?: string | null
    main: string
    engines: {
      cadcam: string
    }
    permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
    dependencies?: {
      [key: string]: string
    } | null
    contributes?: {
      sidebar?: {
        title: string
        icon: string
        entry: string
      } | null
      commands?: Array<{
        id: string
        title: string
        icon?: string | null
        keybinding?: string | null
      }> | null
      menus?: {
        toolbar?: Array<{
          command: string
          group?: string | null
          when?: string | null
          priority?: number | "Infinity" | "-Infinity" | "NaN" | null
        }> | null
        contextMenu?: Array<{
          command: string
          group?: string | null
      } | null
      propertyPanel?: Array<{
        id: string
        title: string
        entry: string
        appliesTo?: string | null
      themes?: Array<{
        id: string
        label: string
        path: string
      }> | null
    } | null
    configuration?: {
      properties: {
        [key: string]: {
          type: string
          default?: unknown | null
          description?: string | null
          enum?: unknown[] | null
          minimum?: number | null
          maximum?: number | null
          pattern?: string | null
        }
      }
    } | null
  } | null
  config?: object | null
}
回应
200 目的 application/json 
{
  id: string
  manifest: {
    id: string
    name: string
    version: string
    description: string
    author: string
    repository?: string | null
    license?: string | null
    icon?: string | null
    main: string
    engines: {
      cadcam: string
    }
    permissions: Array<"model:read" | "model:write" | "model:selection" | "ui:sidebar" | "ui:toolbar" | "ui:contextMenu" | "ui:propertyPanel" | "ui:modal" | "ui:overlay" | "storage:local" | "storage:sync" | "file:read" | "file:write" | "file:downloads" | "network:origin" | "network:external" | "system:clipboard" | "system:notifications" | "ui:fullscreen" | "device:camera" | "device:microphone">
    dependencies?: {
      [key: string]: string
    } | null
    contributes?: {
      sidebar?: {
        title: string
        icon: string
        entry: string
      } | null
      commands?: Array<{
        id: string
        title: string
        icon?: string | null
        keybinding?: string | null
      }> | null
      menus?: {
        toolbar?: Array<{
          command: string
          group?: string | null
          when?: string | null
          priority?: number | "Infinity" | "-Infinity" | "NaN" | null
        }> | null
        contextMenu?: Array<{
          command: string
          group?: string | null
      } | null
      propertyPanel?: Array<{
        id: string
        title: string
        entry: string
        appliesTo?: string | null
      themes?: Array<{
        id: string
        label: string
        path: string
      }> | null
    } | null
    configuration?: {
      properties: {
        [key: string]: {
          type: string
          default?: unknown | null
          description?: string | null
          enum?: unknown[] | null
          minimum?: number | "Infinity" | "-Infinity" | "NaN" | null
          maximum?: number | null
          pattern?: string | null
        }
      }
    } | null
  }
  state: "none" | "installed" | "enabled" | "disabled" | "loaded" | "activated" | "deactivated" | "error"
  enabled: boolean
  version: string
  installedAt: string
  updatedAt: string
  config?: object | null
  configurationId?: string | null
  errorCount: number | "Infinity" | "-Infinity" | "NaN"
  lastError?: string | null
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.patch 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsPatchInput
const result = await client.plugins.patch({
  id: "<id>",
  manifest: {
    id: "",
    name: "",
    version: "",
    description: "",
    author: "",
    main: "",
    engines: {
      cadcam: ""
    },
    permissions: [
      "model:read"
    ]
  },
  config: {}
})
curl
补丁 /api/plugins/{id}/update 
curl --request PATCH "${CADCAMFUN_URL}/api/plugins/<id>/update" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}" \
  --header "Content-Type: application/json" \
  --data-binary @request.json
尝试一下

/api/plugins/registry

得到 /api/plugins/registry # plugins.registry

需要 Authorization: Bearer <token>.

回应
200 数组<对象> application/json 
Array<{
  id: string
  name: string
  version: string
  description: string
  author: string
  entryPoint: string
  homepage?: string | null
  repository?: string | null
  dependencies: {
    [key: string]: string
  }
  permissions: string[]
  extensionPoints: string[]
  minAppVersion: string
  maxAppVersion?: string | null
}>
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
响应示例 捕获·200
获取/api/插件/注册表 
[]
SDK示例
plugins.registry 
import { CadCam } from "@cadcamfun/api/sdk"

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

// no input
const result = await client.plugins.registry()
curl
获取/api/插件/注册表 
curl --request GET "${CADCAMFUN_URL}/api/plugins/registry" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下
得到 /api/plugins/registry/{id} # plugins.registryGet

需要 Authorization: Bearer <token>.

参数
姓名在类型必需的
iD 小路 细绳 必需的
回应
200 目的 application/json 
{
  id: string
  name: string
  version: string
  description: string
  author: string
  entryPoint: string
  homepage?: string | null
  repository?: string | null
  dependencies: {
    [key: string]: string
  }
  permissions: string[]
  extensionPoints: string[]
  minAppVersion: string
  maxAppVersion?: string | null
}
400 PluginBadRequestEncoded application/json 
PluginBadRequestEncoded
401 UnauthorizedEncoded application/json 
UnauthorizedEncoded
404 PluginNotFoundEncoded application/json 
PluginNotFoundEncoded
500 KeyedInternalEncoded application/json 
KeyedInternalEncoded
SDK示例
plugins.registryGet 
import { CadCam } from "@cadcamfun/api/sdk"

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

// PluginsRegistryGetInput
const result = await client.plugins.registryGet({
  id: "<id>"
})
curl
获取 /api/plugins/registry/{id} 
curl --request GET "${CADCAMFUN_URL}/api/plugins/registry/<id>" \
  --header "Authorization: Bearer ${CADCAMFUN_TOKEN}"
尝试一下

模式

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

KeyedInternalEncoded
{
  _tag: "KeyedInternal"
  error: string
}
PluginBadRequestEncoded
{
  _tag: "PluginBadRequest"
  error: string
  details?: string[] | null
}
PluginConflictEncoded
{
  _tag: "PluginConflict"
  error: string
}
PluginNotFoundEncoded
{
  _tag: "PluginNotFound"
  error: string
}
UnauthorizedEncoded
{
  _tag: "Unauthorized"
  message: string
}

呼叫该群组

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