Skip to main content

Module api_endpoints

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 中的常量端点系统配合使用:

  • 枚举端点:用于生产代码(推荐)
  • 常量端点:用于测试和文档示例

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

Enums§

BaikeApiV1
Baike知识库 API v1 端点
BaseApiV2
Base API V2 端点枚举
BitableApiV1
Bitable API V1 端点枚举
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
CcmDriveExplorerApi
CCM Drive Explorer API V1 端点枚举 对应 meta.project = ccm_drive_explorer, meta.version = v1
CcmDriveExplorerApiOld
CCM Drive Explorer API Old V2 端点枚举 对应 meta.project = ccm_drive_explorer, meta.version = old
CcmSheetApiOld
CCM Sheet API Old V2 端点枚举 对应 meta.project = ccm_sheet, meta.version = old
DocsApiV1
Docs API V1 端点枚举
DocxApiV1
Docx API V1 端点枚举
DriveApi
Drive API 端点枚举
LingoApiV1
Lingo语言服务 API v1 端点
MinutesApiV1
Minutes API V1 端点枚举
PermissionApi
CCM Drive Permission API V1 端点枚举 对应 meta.project = permission, meta.version = v1
PermissionApiOld
CCM Drive Permission API Old V2 端点枚举 对应 meta.project = permission, meta.version = old
SheetsApiV3
Sheets API v3 端点枚举 对应 meta.project = sheets, meta.version = v3
WikiApi
Wiki API 端点枚举
WikiApiV1
Wiki API V1 端点枚举
WikiApiV2
Wiki API V2 端点枚举

Constants§

BAIKE_API_V1
公开项说明。
LINGO_API_V1
公开项说明。
SHEETS_API_V3
公开项说明。