4 个版本
0.1.1 | 2022年12月6日 |
---|---|
0.1.0 | 2022年11月11日 |
0.0.2 | 2022年1月18日 |
0.0.1 | 2022年1月18日 |
2165 在 网页编程
38KB
658 代码行
Yupdates Rust SDK
Yupdates Rust SDK 允许您轻松地在自己的软件和脚本中使用 Yupdates API。
该项目托管在 GitHub 上。还有一个 Yupdates Python SDK。
概览
api
模块提供了一组低级函数,用于封装对 HTTP+JSON API 的调用,序列化和反序列化请求和响应。
clients
模块提供了一个更方便的 async
客户端,而 clients::sync
提供了一个同步版本的客户端,隐藏了设置异步运行时的需求。
入门
首先,从应用程序获取 API 令牌。转到“设置”然后“API”。
示例将从只读操作开始,因此您可以使用通用的只读令牌开始。
创建一个新的 Rust 项目
$ cargo new yupdates-example
$ cd yupdates-example
将依赖项添加到 Cargo.toml
[dependencies]
yupdates = "0"
将以下内容添加到 src/main.rs
文件
use yupdates::api::YupdatesV0;
use yupdates::clients::sync::new_sync_client;
use yupdates::errors::Error;
fn main() -> Result<(), Error> {
let yup = new_sync_client()?;
let response = yup.ping()?;
println!("Ping worked: {}", response.message);
Ok(())
}
设置 API 令牌环境变量(使用不同的值,此示例将无法工作)
set +o history
export YUPDATES_API_TOKEN="789a4e8703:78b15453350458054b84443819060b1a213382cc697a5"
set -o history
测试连接和身份验证
cargo run
一旦工作正常,您就可以进行其他调用。例如,从源读取最新的 10 个条目
use yupdates::api::YupdatesV0;
use yupdates::clients::sync::new_sync_client;
use yupdates::errors::Error;
fn main() -> Result<(), Error> {
let feed_id = "02fb24a4478462a4491067224b66d9a8b2338ddca2737";
let yup = new_sync_client()?;
for item in yup.read_items(feed_id)? {
println!("Title: {}", item.title);
}
Ok(())
}
测试和代码文档中还有更多示例。您可以在 GitHub 上的测试 中查看,并在 docs.rs 上的代码文档 中查看。
获取帮助
您可以在本仓库中创建一个 GitHub 问题,用于报告错误和功能请求。
获取帮助最快的方式是通过 Yupdates 应用创建支持票证。或者发送电子邮件至 support@yupdates.com
。特别是如果您需要非特定于此 SDK 的帮助,或者如果您需要更深入的设置和故障排除建议。
许可证
SDK 在 MIT 许可证下分发,有关更多信息,请参阅 LICENSE。
这包括源代码和示例,但不包括 Yupdates 标志或 API 文档等相关项目,这些项目不在此托管。
依赖项
~5–21MB
~273K SLoC