Skip to main content

Crate openlark_platform

Crate openlark_platform 

Source
Expand description

§OpenLark 平台服务模块

OpenLark SDK 的平台服务模块，提供飞书平台管理相关 API 的完整访问。

§功能特性

  • 应用引擎: 应用管理、多租户、应用市场集成
  • 目录服务: 用户搜索、组织目录、人员查找
  • 系统管理: 系统配置、后台管理、平台工具

§模块组织

本模块按业务域（bizTag）组织，分两类入口（ADR 0001）：

  • Service accessor 入口（含路径参数绑定层，经 PlatformService::xxx()）： app_engine（37 APIs）、directory（21 APIs）、admin（14 APIs）、spark（1 API）
  • flat-by-design 直路径（叶子 new(Config) 无路径参数，无 Service 壳，同 analytics 裁决）： mdm、tenant、trust_party

§使用示例

use openlark_platform::PlatformService;
use openlark_core::prelude::Config;

// 使用 builder 模式创建配置
let config = Config::builder()
    .app_id("app_id")
    .app_secret("app_secret")
    .build();

let platform_service = PlatformService::new(config);

// 具体功能请参考各个子模块的文档

Modules§

admin
系统管理模块
app_engine
应用引擎模块
common
通用数据模型
directory
目录服务模块
mdm
主数据管理模块（flat-by-design，ADR 0001）。
prelude
平台服务预导入模块
spark
妙搭平台模块
tenant
租户服务模块（flat-by-design，ADR 0001）。
trust_party
关联组织模块（flat-by-design，ADR 0001）。

Structs§

Config
零拷贝配置共享实现
PlatformService
平台服务

Constants§

VERSION
平台服务模块版本信息

Type Aliases§

PlatformClient
平台服务客户端类型别名（统一命名为 XxxClient）。
PlatformConfig
平台服务配置别名