mixi2 0.1.1

Async Rust SDK for the mixi2 Application API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

# mixi2 Application SDK for Rust

[![crates.io](https://img.shields.io/crates/v/mixi2.svg)](https://crates.io/crates/mixi2)
[![docs.rs](https://docs.rs/mixi2/badge.svg)](https://docs.rs/mixi2)
[![license](https://img.shields.io/crates/l/mixi2.svg)](https://crates.io/crates/mixi2)
[![CI](https://github.com/waki285/mixi2-application-sdk-rust/actions/workflows/ci.yml/badge.svg)](https://github.com/waki285/mixi2-application-sdk-rust/actions/workflows/ci.yml)

Rust SDK for the mixi2 Application API.

This repository migrates [the original Go SDK](https://github.com/mixigroup/mixi2-application-sdk-go) into a single publishable Rust crate.

## Features

- Async-only API surface designed for Tokio
- Vendored `mixigroup/mixi2-api` protobuf snapshot at `v1.1.0`
- Authenticated facade covering every unary Application API RPC
- Webhook signature verification with Ed25519 and timestamp replay protection
- Streaming watcher with Go-compatible reconnect behavior
- High-level builders for validated requests without hiding raw generated types

## Quick Start

```rust
use std::sync::Arc;

use mixi2::{ApiClientBuilder, ClientCredentialsAuthenticator};

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
  let authenticator = Arc::new(
      ClientCredentialsAuthenticator::new("client-id", "client-secret").await?,
  );

  let mut client = ApiClientBuilder::new(authenticator).build().await?;

  let _response = client
      .get_stamps(mixi2::GetStampsRequestBuilder::new().build())
      .await?;

  Ok(())
}
```

## Examples

- `cargo run --example auth`
- `cargo run --example webhook`
- `cargo run --example stream`

Each example reads its configuration from environment variables and loads `.env`
automatically when present. `ClientCredentialsAuthenticator::new(...)` uses the
official token endpoint `https://application-auth.mixi.social/oauth2/token` by
default. Unary API clients default to `https://application-api.mixi.social`,
and stream clients default to `https://application-stream.mixi.social` unless
you override the transport with `with_endpoint` or `with_channel`.
`MIXI2_WEBHOOK_PUBLIC_KEY` must be the base64-encoded 32-byte Ed25519 public
key. Copy `.env.example` to `.env`, fill in the values, and run the example you need.
The `auth` example prints the fetched bearer token to stdout.

## Development

```bash
cargo build --examples
cargo test
```

## License

Apache-2.0