botx-api

描述

对 eXpress api 的封装

使用

添加到 Cargo.toml

botx-api = { version = "*", features = ["anthill-di"] }

以下功能可用

botx-api-v-all - 包含所有版本的功能（默认值）
botx-api-v2 - 包含所有 2 版本 api
botx-api-v3 - 包含所有 3 版本 api
botx-api-v4 - 包含所有 4 版本 api
anthill-di - 添加对 anthill-di 和 async-trait-with-sync 的依赖（在 anthill-di 中添加 BotXApiContext 构造函数的注册）

token - 启用机器人认证 api
notifications-internal - 启用发送事件（机器人）的 api
notifications-direct - 启用发送事件（消息）的 api
events-edit_event - 启用编辑事件（消息）的 api
events-reply_event - 启用对事件（消息）的响应的 api
events-status - 启用请求事件状态的 api
events-typing - 启用启用打印状态的 api
events-stop_typing - 启用停止打印状态的 api
files-upload - 启用上传文件的 api
files-download - 启用下载文件的 api
stickers-new_sticker_pack - 启用创建贴纸包的 api
stickers-sticker_packs_list - 启用请求贴纸包列表的 api
stickers-add_sticker - 启用添加贴纸包的 api
stickers-get_sticker_pack - 启用请求贴纸包信息的 api
stickers-get_sticker - 启用请求贴纸信息的 api
stickers-update_sticker_pack - 启用更新贴纸包的 api
stickers-delete_sticker - 启用删除贴纸的 api
stickers-delete_sticker_pack - 启用删除贴纸包的 api
chats-list - 启用请求机器人聊天列表的 api
chats-info - 启用请求机器人聊天信息的 api
chats-add_use - 启用将用户添加到机器人聊天的 api
chats-remove_use - 启用从机器人聊天中删除用户的 api
chats-add_admin - 启用将管理员添加到机器人聊天的 api
chats-set_stealth - 启用启用隐形模式的 api
chats-disable_stealth - 启用禁用隐身模式的API
chats-create - 启用创建新聊天的API
chats-pin_message - 启用在聊天中固定消息的API
chats-unpin_message - 启用在聊天中解除消息固定的API
users-by_email - 启用通过电子邮件地址查询用户信息的API
users-by_huid - 启用通过huid查询用户信息的API
chats-by_login - 启用通过ad登录和ad域名查询用户信息的API
chats-by_other_id - 启用通过其他id查询用户信息的API
users-users_as_csv - 启用查询用户列表的API

使用

要使用，请创建BotXApiContext对象

• 通过new方法 - 使用默认客户端设置和机器人配置
• 通过from_client方法 - 使用配置好的reqwest::async_impl::client::Client和机器人配置
• 通过from_env_with_default_client方法 - 使用默认客户端设置和从环境变量中获取的机器人配置
• 通过from_env方法 - 使用配置好的reqwest::async_impl::client::Client和从环境变量中获取的机器人配置
• 通过在anthill_di中注册 - 使用extensions::IBotXApiContextExt::register_botx_api_context方法在di上下文中注册BotXApiContext，可选地注册BotXApiContextConfiguration对象作为Singleton，reqwest::async_impl::client::Client，ApiEndpoints（否则将使用默认设置，即从环境变量中获取的机器人配置）

机器人配置来自环境变量

• BOTX_API_CTS_URL - cts服务器URL
• BOTX_API_BOT_ID - 机器人id
• BOTX_API_BOT_SECRET_KEY - 机器人密钥

所有模型都实现了builder模式。使用示例

let internal_notification_request = InternalNotificationRequestBuilder::default()
    .with_group_chat_id(uuid::Uuid::from_str("de981642-5224-4e70-a8dd-9a933a8e096e"))
    .with_data(PingBotsCommandData { })
    .with_opts(PingBotsCommandOption { })
    .build()
    .expect("Не все поля запроса были указаны");

为自动更新认证添加了retry_with_auth方法

let internal_notification_request = InternalNotificationRequestBuilder::default()
    .with_group_chat_id(uuid::Uuid::from_str("de981642-5224-4e70-a8dd-9a933a8e096e"))
    .with_data(PingBotsCommandData { })
    .with_opts(PingBotsCommandOption { })
    .build()
    .expect("Не все поля запроса были указаны");

let internal_notification_result = retry_with_auth(&self.api, || internal_notification(&self.api, &internal_notification_request)).await;

在anthill-di中注册时，可以注册自己的ApiEndpoints对象，这允许更改API（无意义但可能）

逻辑通过crate log写入日志。启用日志记录以更好地了解应用程序的工作方式

贡献

打开issue提出问题或建议

许可证

MIT，可用于任何目的

项目状态