logo
0
0
WeChat Login
galaxy<wzh880801@163.com>
docs: add README with project overview

飞书妙搭 Open API 文档

本仓库包含飞书妙搭(Spark)Open API 的相关文档,方便 Agent 快速了解和使用。

文件说明

文件说明
AGENTS.mdAPI 使用速查手册,包含详细的接口说明、请求/响应示例、实测注意事项及最佳实践。建议优先阅读此文件。
openapi.yamlOpenAPI 规范文件(OpenAPI 3.0),可用于生成客户端代码或导入 API 调试工具。

快速开始

  1. 查看 AGENTS.md 了解 API 的通用约定、认证方式及各接口的详细使用说明
  2. 如需生成客户端代码,可使用 openapi.yaml 配合 OpenAPI 生成器

概述

飞书妙搭 Open API 提供以下能力:

  • 数据表操作:增删改查数据表记录
  • 视图查询:通过预定义视图获取数据
  • 枚举管理:获取自定义枚举类型定义
  • SQL 执行:直接执行 SQL 语句

关键注意点

  • 认证头使用 Authorization: Bearer <user_access_token>
  • records / items 字段为 JSON 字符串(需二次解析)
  • filter / select / order 遵循 PostgREST 语法
  • 详细注意事项请参考 AGENTS.md