メインコンテンツまでスキップ

はじめに

ベータ版

このライブラリは現在ベータ版です。API実装は完了していますが、テストカバレッジは最小限です。テスト結果に基づき、レスポンスモデルやメソッドシグネチャが変更される可能性があります。

レスポンスモデルの不備や予期しない動作を発見された場合は、GitHub Issues での報告、または Pull Request の送信をお願いいたします。

インストール​

pubspec.yaml に以下を追加してください。

dependencies:
  misskey_client: ^1.0.0-beta.1

その後、依存関係を取得します。

dart pub get

基本的な使い方​

MisskeyClient を使うには、MisskeyClientConfig と TokenProvider を用意します。

import 'package:misskey_client/misskey_client.dart';

final config = MisskeyClientConfig(
  baseUrl: 'https://misskey.example.com',
  userAgent: 'MyApp/1.0.0',
);

final tokenProvider = StaticTokenProvider('your_access_token');

final client = MisskeyClient(
  config: config,
  tokenProvider: tokenProvider,
);

最初のAPI呼び出し​

meta.fetch でサーバー情報を取得できます。

final meta = await client.meta.fetch();
print(meta.name);
print(meta.version);

API構造の概要​

MisskeyClient は25のAPIドメインを提供します。

プロパティ説明
client.notesノートの取得・作成・検索
client.usersユーザー情報・フォロー管理
client.driveファイルストレージ
client.notifications通知の取得と管理
client.metaサーバーメタ情報

すべてのAPIはHTTP POSTで通信します。トークンはリクエストボディの i フィールドとして送信されます。

ログ制御​

デフォルトでは StdoutLogger がログを出力します。ログを無効にするには enableLog: false を設定します。

final config = MisskeyClientConfig(
  baseUrl: 'https://misskey.example.com',
  enableLog: false,
);

詳細はロギングを参照してください。

次のステップ​