Skip to content

foxzool/openlark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1,569 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

crates.io MIT/Apache 2.0 Quality Documentation

飞书开放平台非官方SDK - 企业级高覆盖率Rust实现

🏗️ 19 个业务模块,1,560+ 个 API,企业级质量保证。

🎯 测试覆盖率 ~47%,已通过工作区 check/test,全模块 Builder 模式统一。

支持自定义机器人、长连接机器人、云文档、飞书卡片、消息、群组、招聘管理等API调用。

🚀 快速开始

1. 添加依赖

在您的 Cargo.toml 中添加:

[dependencies]
openlark = { version = "0.15.0-rc.2", default-features = false, features = ["auth"] }

2. 选择功能组合

默认配置(仅认证能力):

openlark = "0.15.0-rc.2"

推荐业务开发

openlark = { version = "0.15.0-rc.2", default-features = false, features = ["auth", "communication"] }

按需选择

# 文档协作:多维表格 + Sheets helper
openlark = { version = "0.15.0-rc.2", default-features = false, features = ["auth", "docs-bitable"] }

# 云盘上传/文件夹遍历
openlark = { version = "0.15.0-rc.2", default-features = false, features = ["auth", "docs-drive"] }

# 自定义机器人卡片 + 签名
openlark = { version = "0.15.0-rc.2", default-features = false, features = ["webhook-card", "webhook-signature"] }

# 通讯 + 文档组合
openlark = { version = "0.15.0-rc.2", default-features = false, features = ["auth", "communication", "docs-bitable"] }

# 文档全量能力
openlark = { version = "0.15.0-rc.2", default-features = false, features = ["auth", "docs-full"] }

2.1 选择平台 Endpoint

OpenLark 默认使用国内飞书开放平台 endpoint:

  • 国内飞书:https://open.feishu.cn
  • 国际版 Lark:https://open.larksuite.com

两者的 API 路径结构保持一致,通常都是 /open-apis/...,切换时只需要修改 base_url

2.2 配置 Endpoint

可以通过构建器或环境变量切换:

use open_lark::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let _client = Client::builder()
        .app_id("your_app_id")
        .app_secret("your_app_secret")
        .base_url("https://open.larksuite.com")
        .build()?;

    Ok(())
}
export OPENLARK_BASE_URL="https://open.larksuite.com"

3. 基础使用

use open_lark::prelude::*;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::builder()
        .app_id("your_app_id")
        .app_secret("your_app_secret")
        .build()?;

    // 自动分页读取文件夹子项
    let children = client
        .docs
        .list_folder_children_all("folder_token", Some("sheet"))
        .await?;
    println!("文件夹子项数量: {}", children.len());

    // 按标题查找工作表并批量读取范围
    let sheet = client
        .docs
        .find_sheet_by_title("spreadsheet_token", "汇总表")
        .await?;
    let ranges = client
        .docs
        .read_multiple_ranges(
            "spreadsheet_token",
            vec![format!("{}!A1:C10", sheet.sheet_id)],
        )
        .await?;
    println!("读取范围数量: {}", ranges.value_ranges.len());

    // 多维表格全量读取
    let records = client
        .docs
        .search_bitable_records_all("app_token", "table_id")
        .await?;
    println!("记录数量: {}", records.len());

    Ok(())
}

🔄 架构重构

重构原因

本次重构旨在将项目从早期快速开发模式升级为企业级 SDK 架构:

目标 说明
🔗 统一 API 调用模式 将散乱的 API 实现统一为 Builder 模式,提供一致的开发体验
🚪 单入口架构 实现 ServiceRegistry 统一服务注册,所有服务通过 Client 单入口访问
📦 模块化设计 按业务领域拆分为独立 crates(通讯、文档、HR、会议等),支持按需引入
🧹 技术债务清理 清理过时模块、简化 trait 系统、移除死代码和硬编码 URL

重构进度

模块 状态 API 数量 说明
openlark-core ✅ 完成 - 核心基础设施,HTTP 客户端,错误处理
openlark-client ✅ 完成 - 单入口架构,ServiceRegistry
openlark-protocol ✅ 完成 - WebSocket 协议
openlark-auth ✅ 完成 15 Token 管理,认证服务
openlark-hr ✅ 完成 562 招聘、CoreHR、考勤、薪酬等
openlark-docs ✅ 完成 158 云文档、多维表格、知识库、会议纪要
openlark-communication ✅ 完成 175 IM 消息、联系人、群组
openlark-workflow ✅ 完成 117 任务、审批、看板
openlark-meeting ✅ 完成 117 视频会议、日历
openlark-platform ✅ 完成 102 平台服务、Transport API
openlark-application ✅ 完成 83 应用管理
openlark-mail ✅ 完成 68 邮件服务
openlark-helpdesk ✅ 完成 56 帮助台
openlark-security ✅ 完成 38 安全服务
openlark-ai ✅ 完成 29 AI 智能助手
openlark-analytics ✅ 完成 20 数据分析
openlark-cardkit ✅ 完成 10 卡片组件
openlark-webhook ✅ 完成 8 自定义机器人、Webhook
openlark-user ✅ 完成 9 用户设置

新架构特点

// 根 crate 单入口
let client = Client::from_env()?;

// 文档 helper
client.docs.list_folder_children_all("folder_token", None).await?;
client.docs.find_sheet_by_title("spreadsheet_token", "汇总表").await?;

// 通讯模块
let endpoint = open_lark::communication::endpoints::IM_V1_MESSAGES;
println!("{}", endpoint);
  • 🔗 单入口访问 - 从 Client 出发,按 feature 打开需要的能力
  • 🛡️ 类型安全 - 编译时验证所有 API 调用参数
  • ⚡ 按需编译 - 50+ feature flags 支持按需引入功能
  • 🏢 企业级质量 - 零警告构建,严格 clippy 检查

📖 文档和资源

​​📊 项目状态

  • 核心模块稳定 - openlark-core、openlark-client、openlark-auth 生产就绪
  • 功能模块持续完善 - 各业务模块 API 持续补充中
  • 测试覆盖率 ~47% - 核心模块完整测试覆盖

已完成

  • ✅ 核心基础设施(core、client、protocol、auth)
  • ✅ 18 个业务模块全部实现,共 1,560+ 个 API
  • ✅ openlark-hr 562 个 API(招聘、CoreHR、考勤、薪酬)
  • ✅ openlark-communication 175 个 API
  • ✅ openlark-docs 158 个 API(云文档、多维表格、知识库)
  • ✅ openlark-workflow 117 个 API(任务、审批、看板)
  • ✅ openlark-meeting 117 个 API(视频会议、日历)
  • ✅ 链式调用架构 + Builder 模式统一
  • ✅ Feature flags 按需编译
  • ✅ 测试覆盖率 ~47%

进行中

  • 🔄 部分 API 结构体字段文档补充
  • 🔄 更多示例和文档完善

计划中

  • 更多事件处理器支持
  • WebSocket 功能完善

🤝 贡献

欢迎提交 Issue 和 Pull Request!

📄 许可证

MIT OR Apache-2.0

About

飞书开放平台的非官方 Rust SDK,支持自定义机器人、长连接机器人、云文档、飞书卡片、消息、群组等 API 调用。

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages