Skip to content

定义 Feed/Chatter 协议 API 端点(Feed CRUD、Reactions、Subscription) #733

@hotlong

Description

@hotlong

背景

[Feed/Chatter 协议相关数据模型、UI props 已完成](#731 & PR#732)。目前暂无配套的 API 协议,无法规范服务端和前端协作的接口约定。

目标

  • 定义统一的 Feed/Chatter 接口端点,包括 Feed CRUD、Reactions、Subscription
  • 明确请求/响应参数 schema,便于前后端约束和 mock
  • 对标 Airtable/Salesforce/Notion Timeline

推荐端点

  • GET /api/data/{object}/{recordId}/feed?type=all&limit=20&cursor=xxx — 拉取某条记录的活动时间线(混合评论、字段变更、task 等,支持翻页和类型筛选)

  • POST /api/data/{object}/{recordId}/feed { type: 'comment', body: '...'} — 新增评论/任务等 Feed 项

  • PUT /api/data/{object}/{recordId}/feed/{feedId} { body: '...'} — 编辑评论等

  • DELETE /api/data/{object}/{recordId}/feed/{feedId} — 删除 Feed 项(如评论)

  • POST /api/data/{object}/{recordId}/feed/{feedId}/reactions { emoji: '👍'} — 增加 emoji reaction

  • DELETE /api/data/{object}/{recordId}/feed/{feedId}/reactions/{emoji} — 移除 reaction

  • POST /api/data/{object}/{recordId}/subscribe { events: ['comment'...'field_change'...'all'], channels: ['in_app'...'email']}

  • DELETE /api/data/{object}/{recordId}/subscribe

期望

  • 每个端点均应有详细的请求/响应参数 JSON schema(建议 Zod/TSType/JSON Schema)
  • 补充接口错误说明,例如权限不足、非法操作
  • 示例:如何通过 API 拉取包含评论、字段变更、回复和 reaction 的 unified feed 时间线

参考


test


建议实现:可新建 src/api/feed-api.zod.ts 或在现有 API contract 体系扩展

完成后请运行 test,并更新 ROADMAP

Metadata

Metadata

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions