Flutter动漫信息获取插件jikan_api的使用

简介

Jikan 是一个 非官方 的 MyAnimeList API。它通过抓取网站数据来满足对完整API的需求，而这些是MyAnimeList所缺乏的。jikan_api 是基于Jikan的一个Dart包，适用于Flutter项目，能够帮助开发者轻松地获取和操作动漫、漫画以及相关人物的信息。

• Build Status
• pub package

功能概述

Anime（动漫）

Future<Anime> getAnime(int id);
Future<BuiltList<CharacterMeta>> getAnimeCharacters(int id);
Future<BuiltList<PersonMeta>> getAnimeStaff(int id);
Future<BuiltList<Episode>> getAnimeEpisodes(int id, {int page = 1});
Future<BuiltList<Article>> getAnimeNews(int id, {int page = 1});
Future<BuiltList<Forum>> getAnimeForum(int id, {ForumType? type});
Future<BuiltList<Promo>> getAnimeVideos(int id);
Future<BuiltList<Picture>> getAnimePictures(int id);
Future<Stats> getAnimeStatistics(int id);
Future<String> getAnimeMoreInfo(int id);
Future<BuiltList<Recommendation>> getAnimeRecommendations(int id);
Future<BuiltList<UserUpdate>> getAnimeUserUpdates(int id, {int page = 1});
Future<BuiltList<Review>> getAnimeReviews(int id, {int page = 1});

Manga（漫画）

Future<Manga> getManga(int id);
Future<BuiltList<CharacterMeta>> getMangaCharacters(int id);
Future<BuiltList<Article>> getMangaNews(int id, {int page = 1});
Future<BuiltList<Forum>> getMangaForum(int id, {ForumType? type});
Future<BuiltList<Picture>> getMangaPictures(int id);
Future<Stats> getMangaStatistics(int id);
Future<String> getMangaMoreInfo(int id);
Future<BuiltList<Recommendation>> getMangaRecommendations(int id);
Future<BuiltList<UserUpdate>> getMangaUserUpdates(int id, {int page = 1});
Future<BuiltList<Review>> getMangaReviews(int id, {int page = 1});

People（人物）

Future<Person> getPerson(int id);
Future<BuiltList<Picture>> getPersonPictures(int id);

Characters（角色）

Future<Character> getCharacter(int id);
Future<BuiltList<Picture>> getCharacterPictures(int id);

Search（搜索）

Future<BuiltList<Anime>> searchAnime(
    {String? query, AnimeType? type, List<int>? genres, List<int>? producers, String? orderBy, String? sort, int page = 1});
Future<BuiltList<Manga>> searchManga(
    {String? query, MangaType? type, List<int>? genres, List<int>? magazines, String? orderBy, String? sort, int page = 1});
Future<BuiltList<Person>> searchPeople({String? query, String? orderBy, String? sort, int page = 1});
Future<BuiltList<Character>> searchCharacters({String? query, String? orderBy, String? sort, int page = 1});

Seasons（季度）

Future<BuiltList<Anime>> getSeason({int? year, SeasonType? season, int page = 1});
Future<BuiltList<Anime>> getSeasonUpcoming({int page = 1});
Future<BuiltList<Archive>> getSeasonsList();

Schedules（排期）

Future<BuiltList<Anime>> getSchedules({WeekDay? weekday, int page = 1});

Top（排行榜）

Future<BuiltList<Anime>> getTopAnime({AnimeType? type, TopFilter? filter, int page = 1});
Future<BuiltList<Manga>> getTopManga({MangaType? type, TopFilter? filter, int page = 1});
Future<BuiltList<Person>> getTopPeople({int page = 1});
Future<BuiltList<Character>> getTopCharacters({int page = 1});
Future<BuiltList<UserReview>> getTopReviews({int page = 1});

Genres（类型）

Future<BuiltList<Genre>> getAnimeGenres({GenreType? type});
Future<BuiltList<Genre>> getMangaGenres({GenreType? type});

Producers（制作公司）

Future<BuiltList<Producer>> getProducers({String? query, String? orderBy, String? sort, int page = 1});

Magazines（杂志）

Future<BuiltList<Magazine>> getMagazines({String? query, String? orderBy, String? sort, int page = 1});

Users（用户）

Future<UserProfile> getUserProfile(String username);
Future<BuiltList<History>> getUserHistory(String username, {HistoryType? type});
Future<BuiltList<Friend>> getUserFriends(String username, {int page = 1});
Future<BuiltList<UserReview>> getUserReviews(String username, {int page = 1});
Future<BuiltList<UserRecommendation>> getUserRecommendations(String username, {int page = 1});

Reviews（评论）

Future<BuiltList<UserReview>> getRecentAnimeReviews({int page = 1});
Future<BuiltList<UserReview>> getRecentMangaReviews({int page = 1});

Recommendations（推荐）

Future<BuiltList<UserRecommendation>> getRecentAnimeRecommendations({int page = 1});
Future<BuiltList<UserRecommendation>> getRecentMangaRecommendations({int page = 1});

Watch（观看）

Future<BuiltList<WatchEpisode>> getWatchEpisodes({bool popular = false});
Future<BuiltList<WatchPromo>> getWatchPromos({bool popular = false});

示例代码

以下是一个简单的例子，展示了如何使用 jikan_api 包来获取排名前20的TV动漫列表：

import 'package:jikan_api/jikan_api.dart';

void main() async {
  // 创建 Jikan 实例
  final jikan = Jikan();
  
  try {
    // 获取排名前20的TV动漫
    final topAnime = await jikan.getTopAnime(type: AnimeType.tv);
    
    // 打印结果
    for (var anime in topAnime) {
      print('Title: ${anime.title}, Episodes: ${anime.episodes}');
    }
  } catch (e) {
    print('Error fetching data: $e');
  }
}

此代码段首先导入了 jikan_api 包，然后创建了一个 Jikan 类的实例。接着调用了 getTopAnime 方法来获取排名前20的TV动漫，并将结果打印出来。如果请求过程中出现任何错误，则会捕获并打印出来。

希望这能帮助你更好地理解和使用 jikan_api 插件！如果有更多问题或需要进一步的帮助，请随时提问。