Skip to main content

Module api_endpoints

openlark_docs::common

Module api_endpoints 

Source
Expand description

文档服务 API 端点定义。 API端点定义（类型安全枚举系统）

本模块提供基于枚举的 API 端点定义，用于生产代码中的类型安全调用。

§使用场景

§生产代码（推荐）

使用枚举端点获得编译时类型检查和动态 URL 生成能力：

use openlark_docs::common::api_endpoints::BitableApiV1;

let app_token = "app_token".to_string();
let table_id = "table_id".to_string();
let endpoint = BitableApiV1::RecordCreate(app_token, table_id);
let url = endpoint.to_url(); // 类型安全，动态生成
assert!(url.contains("/open-apis/bitable/v1/"));

§特性

  • ✅ 类型安全：编译时验证参数
  • ✅ 动态生成：支持参数化 URL
  • ✅ 易于维护：集中管理端点定义
  • ✅ 避免错误：消除字符串拼接错误

§与常量端点系统的关系

本模块与 endpoints/mod.rs 中的常量端点系统配合使用：

  • 枚举端点：用于生产代码（推荐）
  • 常量端点：用于测试和文档示例

不建议混合使用两个系统，应根据场景选择合适的端点方式。

Re-exports§

pub use base::BaseApiV2;
pub use bitable::BitableApiV1;
pub use docs::DocsApiV1;
pub use docx::DocxApiV1;
pub use drive::CcmDriveExplorerApi;
pub use drive::CcmDriveExplorerApiOld;
pub use drive::DriveApi;
pub use drive::PermissionApi;
pub use drive::PermissionApiOld;
pub use sheets::CcmSheetApiOld;
pub use sheets::SheetsApiV3;
pub use wiki::WikiApi;
pub use wiki::WikiApiV1;
pub use wiki::WikiApiV2;
pub use lingo::LingoApiV1;
pub use lingo::LingoApiV1 as BaikeApiV1;
pub use minutes::MinutesApiV1;

Modules§

base
Base API V2 端点枚举
bitable
Bitable API V1 端点枚举
docs
Docs API 端点目录。
docx
Docx API 端点目录。
drive
Drive、Explorer 与 Permission API 端点目录。
lingo
Lingo API 端点目录。
minutes
妙记 API 端点目录。
sheets
Sheets API 端点目录。
wiki
Wiki API 端点目录。

Enums§

CcmDocApiOld
CCM Doc API Old V1 端点枚举 对应 meta.project = ccm_doc, meta.version = old
CcmDocsApiOld
CCM Docs API Old V1 端点枚举 对应 meta.project = ccm_docs, meta.version = old

Constants§

LINGO_API_V1
Lingo API v1 端点基础路径（兼容保留）。

Traits§

CatalogEndpoint
端点 catalog 的通用语义接口（#424 / #438）。 允许 to_request 等逻辑共享，减少重复。