Shadow Editor Pro 接口文档

文档说明

本文档提供 Shadow Editor Pro 的完整 API 参考信息，包括所有可用的接口、数据类型和使用方法。

• 基础地址: http://localhost:3000
• API 版本: v0.0.1
• 数据格式: JSON
• 字符编码: UTF-8

通用说明

请求格式

所有 API 请求均使用 RESTful 风格，支持以下方法：

• GET: 获取数据
• POST: 创建或更新数据
• DELETE: 删除数据

响应格式

所有 API 响应均包含统一的 Result 结构：

interface Result<T = any> {
  // 请求是否成功
  success: boolean
  // 响应数据
  data?: T
  // 错误信息
  message?: string
  // 错误代码
  code?: number
}

通用实体

BaseEntity

interface BaseEntity {
  // 实体ID
  id?: string
  // 实体名称
  name?: string
  // 类别ID
  categoryId?: string
  // 创建时间
  createTime?: string
  // 更新时间
  updateTime?: string
}

BaseFileEntity

interface BaseFileEntity extends BaseEntity {
  // 文件名
  filename?: string
  // 文件大小（字节）
  size?: number
  // 文件类型
  type?: string
  // 下载地址
  url?: string
  // 缩略图
  thumbnail?: string
}

目录

• 前端架构

  • 目录结构
  • 核心模块说明
  • 事件系统
  • 开发规范

• 后端架构

  • 技术栈
  • 目录结构
  • NestJS模块
  • API规范
  • 文件存储

• 3D资源接口

  • 场景管理
  • 模型管理
  • 材质管理
  • 动画管理
  • 音频管理
  • 视频管理
  • 贴图管理
  • 字体管理
  • 截图管理
  • 缩略图管理
  • 分类管理

• 业务数据接口

  • 设备管理
  • 测量管理
  • 属性管理
  • 字典管理
  • 站点管理
  • 关联管理

• 公共接口

  • 文件访问
  • 文件下载
  • 文件上传
  • Electron接口

错误代码

支持的文件格式

模型格式

• 3D Studio: .3ds
• 3D Manufacturing: .3mf
• Additive Manufacturing: .amf
• Assimp: .assimp
• Away3D: .awd
• Babylon.js: .babylon
• BVH Animation: .bvh
• Compressed Triangle Mesh: .ctm
• Collada: .dae
• Draco: .drc
• Autodesk FBX: .fbx
• G-Code: .gcode
• GLTF: .gltf, .glb
• Three.js JSON: .js, .json
• Google Earth KMZ: .kmz
• Quake MD2: .md2
• Medical Image: .nrrd
• Wavefront OBJ: .obj
• Point Cloud Data: .pcd
• Protein Data Bank: .pdb
• PlayCanvas: .playcanvas
• Stanford PLY: .ply
• MikuMikuDance: .pmd, .pmx
• 3D Systems STL: .stl
• VRM: .vrm
• VRML: .vrml, .wrl
• VTK: .vtk
• DirectX X: .x

贴图格式

• 图片: .png, .jpg, .gif, .webp
• HDR: .hdr
• 视频: .mp4, .webm

音频格式

• MP3: .mp3
• WAV: .wav
• OGG: .ogg

动画格式

• MMD Animation: .vmd
• MMD Pose: .vpd

字体格式

• TrueType: .ttf
• OpenType: .otf
• JSON: .json (Typeface JSON)

版本历史

v0.0.1 (2024-10-19)

• 初始版本发布
• 支持3D场景编辑
• 支持资源管理
• 支持业务数据管理