Skip to content

端点

/api/riff/createRiffDeck

创建闪卡包 (createRiffDeck)

首页 | Riff API | GitHub Source

功能描述

此 API 端点 POST /api/riff/createRiffDeck 用于创建一个新的闪卡包 (Deck)。

请求参数

请求体必须是 JSON 格式,包含以下参数:

  • name (string): 必填。要创建的闪卡包的名称。名称不能为空,且不能与现有卡包名称重复。

请求示例:

json
{
  "name": "我的新卡包"
}

响应结果

成功的请求将返回一个 JSON 对象,code 为 0,data 字段包含新创建的闪卡包的基本信息。

json
{
  "code": 0,
  "msg": "",
  "data": {
    "id": "20240815153000-xyz1234", // 新卡包的 ID
    "name": "我的新卡包", // 卡包名称
    "size": 0, // 卡片数量 (初始为 0)
    "created": "2024-08-15 15:30:00", // 创建时间
    "updated": "2024-08-15 15:30:00" // 更新时间
  }
}
  • code: 0 表示成功,非 0 表示失败(例如名称重复、名称无效等)。
  • msg: 错误信息(如果 code 非 0)。
  • data: 新创建的闪卡包信息对象,包含 ID (id), 名称 (name), 卡片数 (size), 创建时间 (created), 更新时间 (updated)。

在线测试

您可以在下方输入要创建的闪卡包名称进行在线测试。

API Token:
Endpoint:
Method:
Parameters (JSON):

发送请求

响应结果:

思源笔记 API 文档 | 最后更新时间: