GitHub search APIのページングに対応する

[trm11tkr]

概要

現状は、各検索キーワードに対して1ページ分しか取得してこれないので、ページングに対応する。 パラメータでページ番号を設定できる。

タスク

• [x] リクエストパラメータ用のクラスを作成
• [x] APIリクエストに反映

[trm11tkr]

リクエストパラメータクラスはfreezedで作成

pageパラメータのインクリメントでページングを行う予定なので int型で扱いたいが、toJsonでエラーを吐いてしまうので以下のようにカスタムコンバーターを適用する

class IntAndStringConverter implements JsonConverter<int, String> {
  const IntAndStringConverter();

  @override
  int fromJson(String value) => int.parse(value);

  @override
  String toJson(int value) {
    return value.toString();
  }
}

class RepoSearchRequestParam with _$RepoSearchRequestParam {
  const factory RepoSearchRequestParam({
    required String q,
    String? sort,
    String? order,
    @IntAndStringConverter() @Default(30) int perPage,
    @IntAndStringConverter() @Default(1) int page,
  }) = _RepoSearchRequestParam;

  factory RepoSearchRequestParam.fromJson(Map<String, dynamic> json) =>
      _$RepoSearchRequestParamFromJson(json);
}

[trm11tkr]

リクエストパラメータをクエリに反映させることでページ指定可能にした

final repoSearchProvider = FutureProvider((ref) {
  final searchQuery = ref.watch(searchQueryProvider);
  final requestParam = RepoSearchRequestParam(
    q: searchQuery,
    perPage: 10,
    page: 2,
  );

  return ref.watch(repoSearchClientProvider).get(
        queryParameters: requestParam.toJson(),
        fromJson: GithubReposState.fromJson,
      );
});

[trm11tkr]

取得したリポジトリリストデータの保管方法

• スクロールによってページングしたいので、以前に取得したデータも保持したい。

• StateNotifierProviderを利用

  • クエリパラメータ、取得リポジトリリスト等を保持するStateNotifierクラスを作成する

• エラーが発生しても以前の取得データは表示したい

  • Infinite Pagination in Flutter with Firebase, Riverpod, and Freezeを参考にカスタムAsyncValueクラスを作成する。