Oxide Todo SDK

一个用于oxide_todo的异步SDK（软件开发工具包），用Rust编写。它提供了一个简单的API来与服务器交互。

MSRV（最低支持的Rust版本）

最低支持的Rust版本是1.64.0。（建议在开发期间使用）

使用方法

将此添加到你的Cargo.toml

[dependencies]
oxide_todo_sdk = "0.1.0"

示例

此示例展示了如何创建一个新的待办事项

use oxide_todo_sdk::types::TodoStatus;
use oxide_todo_sdk::Client;
use oxide_todo_sdk::errors::Result as OxideTodoResult;

#[tokio::main]
async fn main() -> OxideTodoResult<()> {
    let todo = Client::new("http://localhost:8080")
        .login("username", "password")
        .await? // Type: oxide_todo_sdk::types::User
        .create_todo("title") // Type: oxide_todo_sdk::types::Todo
        .set_status(TodoStatus::Completed) // Type: oxide_todo_sdk::types::Todo
        .await?; // Type: oxide_todo_sdk::types::Todo
    println!("Todo created: {todo:?}");
    // ^ This need `debug` feature
    Ok(())
}

如上所示，SDK非常灵活，你可以直接await Todo类型。

查看文档以获取更多信息。也可以查看示例以获取更多示例。

功能

• 身份验证
  • 注册
  • 登录
  • 撤销令牌
• 待办事项
  • 创建待办事项
  • 获取待办事项
  • 更新待办事项
  • 删除待办事项
  • 列出待办事项（包括搜索）
  • 删除所有待办事项
• [服务器元数据]
  • 获取服务器元数据

贡献

如果你想为此项目做出贡献，请随意发起pull request。如果你想添加新功能，请首先发起一个issue。如果你有任何问题，请随意发起一个issue。

行为准则

本项目遵守Rust行为准则。参与本项目意味着你将遵守此准则。

许可证

本项目采用MIT许可证。有关更多信息，请参阅LICENSE。