libannict 0.0.13

Annict API のクライアントライブラリ
Documentation

libannict

Annict の Web API のクライアントライブラリ

本ライブラリの利用に必要な Rust の最低バージョン (MSRV): 1.75.0

注意事項

まだ制作初期段階なので、不足している機能や API の破壊的変更が多くあります。

機能の実装状況

  • 読み取り
    • 作品の検索
    • エピソードの検索
    • キャラクターの検索
    • 人物の検索
    • 団体の検索
    • 利用者情報の取得
    • 特定の利用者が視聴状況を記録した作品の検索
    • 特定の利用者が特定の視聴状況を記録した作品の検索
    • 特定の利用者の活動の検索
    • 特定の利用者のエピソード視聴記録の検索
    • 作品群（シリーズ）に含まれる作品の検索
    • 特定の作品が含まれる作品群の検索（Annict のバグにより現在使えません）
  • 書き込み
    • 作品の視聴状況の変更
    • 作品のレビューの作成
    • 作品のレビューの編集
    • 作品のレビューの削除
    • エピソードの視聴記録の作成
    • エピソードの視聴記録の編集
    • エピソードの視聴記録の削除

リポジトリへの貢献について

コントリビューションを歓迎しております！プルリクエストを送る場合、先に issue を立てるようにお願いいたします🙏

使用例

use libannict::Annict;

// クライアントを作成
let client = Annict::new("access_token")?;

作品を検索する

// 作品を検索
let works = client
    .works()
    .filter_title("ゼロの使い魔".to_owned())
    .search(10)
    .await?;

// 作品の情報を利用
for work in works {
    println!("{}", work.title);
}

エピソードを検索する

// エピソードを検索
let episodes = client
    .episodes()
    .filter_work_id(6077)
    .search(20)
    .await?;

// エピソードの情報を利用
for episode in episodes {
    println!("{:?}", episode.title);
}

自分が視聴状況をつけた作品を検索する

use libannict::{work::SortBy, Order};

// 作品を検索
let works = client
    .me()
    .works()
    .sort(SortBy::Season, Order::Desc)
    .search(10)
    .await?;

// 作品の情報を利用
for work in works {
    println!("{}", work.title);
}

特定のユーザーの活動を検索する

use libannict::{Activity, ChangeStatus, Status};

// 活動を検索
let activities = client
    .user("naskya".to_owned())
    .activities()
    .search(10)
    .await?;

// 活動の情報を利用
for activity in activities {
    if let Activity::ChangeStatus(activity) = activity {
        let ChangeStatus { status, work, .. } = activity;
        match status {
            Status::Watched => println!("「{}」を観ました", work.title),
            _ => (),
        }
    }
}

作品の視聴状況を変更する

use libannict::Status;

// ID が 860 の作品の視聴状況を「見た」に変更
let _ = client
    .write_access()
    .change_status(860, Status::Watched)
    .await?;

GraphQL API によって返される ID を直接利用する

use libannict::{AnnictObject, Episode, Work};

// アニメ「AIR」の GraphQL API における ID
let id = "V29yay0yNDE=".to_owned();

// 作品の情報を取得
let work = Work::from_internal_id(&client, id).await?;
assert_eq!(work.title, "AIR");
assert_eq!(work.internal_id(), "V29yay0yNDE=");

ライセンス

graphql/schema.graphql を除く、本リポジトリの内容には

の 2 つのライセンスが適用されます。あなたの選択でどちらのライセンスの下でも利用できます。

詳しくは COPYING を参照してください。

プロジェクトへの貢献

明示的に宣言されない限り、本プロジェクトへのあなたの貢献は上記の通りにデュアルライセンスされます。