open_lark/lib.rs
1#![allow(rustdoc::broken_intra_doc_links)]
2
3//! # open-lark
4//!
5//! 飞书开放平台的非官方 Rust SDK，支持自定义机器人、长连接机器人、云文档、飞书卡片、消息、群组、招聘管理等 API 调用。
6//!
7//! ## 功能特性
8//!
9//! - 🚀 **完整的 API 覆盖**: 支持飞书开放平台的主要 API，包括消息、群组、云文档、招聘等
10//! - 🔐 **自动令牌管理**: 自动缓存和刷新访问令牌，支持多种令牌类型
11//! - 🔌 **事件系统**: 完整的事件处理和分发机制，支持 v1 和 v2 事件格式
12//! - 📡 **WebSocket 支持**: 实时事件处理，支持长连接机器人
13//! - 🎨 **飞书卡片**: 丰富的卡片组件支持，轻松构建交互式消息
14//! - 🛡️ **类型安全**: 充分利用 Rust 的类型系统，编译时保证类型安全
15//! - ⚡ **异步支持**: 完全异步的 API，高性能并发处理
16//!
17//! ## 快速开始
18//!
19//! ```rust,no_run
20//! use open_lark::prelude::*;
21//!
22//! #[tokio::main]
23//! async fn main() -> Result<(), Box<dyn std::error::Error>> {
24//! // 创建客户端
25//! let client = LarkClient::builder("your_app_id", "your_app_secret")
26//! .with_app_type(AppType::SelfBuild)
27//! .with_enable_token_cache(true)
28//! .build();
29//!
30//! println!("飞书开放平台 Rust SDK 初始化成功");
31//! Ok(())
32//! }
33//! ```
34//!
35//! ## 主要模块
36//!
37//! - [`client`][]: 客户端实现和WebSocket支持
38//! - [`core`][]: 核心功能：HTTP传输、配置、错误处理等
39//! - [`service`][]: 所有飞书开放平台API服务的实现
40//! - [`event`][]: 事件处理和分发器
41//! - [`card`][]: 飞书卡片组件和工具
42//! - [`custom_bot`][]: 自定义机器人相关功能
43//! - [`prelude`][]: 常用类型和trait的重导出，方便用户使用
44
45/// 飞书卡片组件和工具
46pub mod card;
47/// 客户端实现和WebSocket支持
48pub mod client;
49/// 核心功能：HTTP传输、配置、错误处理等
50pub mod core;
51// pub mod message;
52/// 自定义机器人相关功能
53pub mod custom_bot;
54/// 事件处理和分发器
55pub mod event;
56/// 常用类型和trait的重导出，方便用户使用
57pub mod prelude;
58/// 所有飞书开放平台API服务的实现
59pub mod service;