pixiv.dart

pixivAPIをDart/Flutterで利用するためのパッケージです。

Features

TODO: List what your package can do. Maybe include images, gifs, or videos.

Getting started

Install

このパッケージは開発中であり、長期的なサポートを想定していないため、pub.devでは公開していません。そのため、パッケージを使用するためにはpubspec.yamlのdependenciesに以下の記述を追加する必要があります。

dependencies:
  pixiv_dart:
    git:
      url: https://github.com/MnyaCat/pixiv_dart
      ref: # バージョンを固定するコミットのハッシュ値を書いてください(例: 0ff847f)。

Retrieving Auth Token

pixivへログインするためには、OAuth認証のアクセストークンを取得する必要があります。
以下の手順に従って、アクセストークンを取得してください。

oauth_flow.dartを実行します。
表示されたリンクをブラウザで開きます。
DevToolsを開き(Google Chromeの場合はF12)、"Network(ネットワーク)"タブに移動します。
"Preserve log(ログを保持)"を有効にし、"Filter"にcallback?を入力します。
pixivへログインしてください。
ログインすると、https://app-api.pixiv.net/web/v1/users/auth/pixiv/callback?state=...&code=...のようなリクエストが表示されます。codeパラメーターの値をコピーして、コンソールにペーストし、Enterを押してください。

アクセストークンの取得に成功すると、コンソールへ取得したトークンが出力されます。
アカウント情報をファイルに保存する場合は、引数--save-accountを付けて実行してください。カレントディレクトリ配下のuser_account.jsonに出力されます。
ここで取得したトークンを利用することで、アカウントにログインできます。誤ってインターネット上にアップロードしないように気をつけてください。

Usage

import 'package:http/http.dart' show Client;
import 'package:pixiv_dart/pixiv_dart.dart';

void main() async {
  final api =
      await ApiClient.loginWithRefreshToken('your refresh token', Client());

  // fetch illust detail
  final illust = await api.fetchIllustDetail(92210213);
  print('title: ${illust.title}');
}

LICENSE

next_urlに対応させる

v1/illust/rankingやv1/illust/recommendedなどはレスポンスに以降のイラストを取得するためのnext_urlが含まれる。
メソッドの引数でnext_urlを受け取れるようにして、next_urlが渡された時はそれを使って取得するようにする。

Before

Future<Illusts> fetchIllustRanking({
  IllustRankingMode? mode,
  int? offset,
  DateTime? date,
}) async {
  final body = <String, String?>{
    'mode': mode?.toSnakeCaseString(),
    'offset': offset?.toString(),
    'date': date?.toDateString()
  }..removeWhere((key, value) => value == null);
  print(body);
  final url = Uri.https(apiHostname, '/v1/illust/ranking', body);
  final header = await getRefreshedHeader();
  final response = await innerClient.get(url, headers: header);
  final jsonResponse = parse(response);
  return Illusts.fromJson(jsonResponse);
}

After

Future<Illusts> fetchIllustRanking({
  IllustRankingMode? mode,
  int? offset,
  DateTime? date,
  // 引数でnext_urlを受け取る
  String? nextUrl
}) async {
  final Uri url;
  // next_urlが渡されたかで分岐
  if (next_url == null) {
    final body = <String, String?>{
      'mode': mode?.toSnakeCaseString(),
      'offset': offset?.toString(),
      'date': date?.toDateString()
    }..removeWhere((key, value) => value == null);
    url = Uri.https(apiHostname, '/v1/illust/ranking', body);
  } else {
    // 渡されている時はURLをパース
    url = Uri.parse(nextUrl);
  }
  final header = await getRefreshedHeader();
  final response = await innerClient.get(url, headers: header);
  final jsonResponse = parse(response);
  return Illusts.fromJson(jsonResponse);
}

mnyacat / pixiv_dart Goto Github PK

pixiv_dart's Introduction

pixiv.dart

Features

Getting started

Install

Retrieving Auth Token

Usage

LICENSE

pixiv_dart's People

Contributors

Stargazers

Watchers

pixiv_dart's Issues

概要

理由など

1. ヘッダーの取得、GETメソッド、JsonMapへのパース

Before

After

ApiClient

Illust API

Manga API

Novel API

Serch API

Ugoira API

User API

Download API

Recommend Projects

Recommend Topics

Recommend Org