Flutter Modrinth API集成插件modrinth_api的使用

Modrinth API for Dart

非官方的Dart库，用于与Modrinth API交互！

此包当前针对Modrinth版本2.7.0/3b22f59。

特性

注意: 此库假定存在互联网连接。如果没有可用的连接，底层的http库将抛出异常。

提前访问

由于该包仍处于v0阶段，随时可能发生重大更改。

例如，目前大多数函数在找不到内容时会抛出异常。对于大多数函数来说，这很有意义，但对于某些函数（例如没有明确路径的情况，如搜索 -> 项目ID -> getProject() -> 版本ID -> getVersion()），它也会抛出异常，而不是返回空值。我希望对此进行更改，但函数的基础已经构建完成，因此使用它们应该只需稍作调整即可正常工作。

开始使用

在您的项目中安装库，如下所示，在终端中运行：

dart pub add modrinth_api

在使用API之前，导入并初始化API：

import "package:modrinth_api/modrinth_api.dart";

void main() async {
  final api = ModrinthApi(project: "my_test_project");
}

注意: 您必须为您的项目指定一个名称（更好的做法是插入您的GitHub用户名）。这样可以让API的开发者更容易看到谁正在使用此包，以防发生速率限制或上传内容出现问题。

如果您有API密钥，可以这样指定它：

final api = ModrinthApi(
  project: "my_test_project",
  apiKey: "my_api_key",
);

添加API密钥后，您可以访问以下功能：getAuthenticatedUser、getUserNotifications、getUserFollowedProjects 和 getUserPayoutHistory。

如果您想使用staging API服务器（非常适合调试和测试目的）或仅使用另一个Modrinth实例，可以在构造函数中指定自定义的baseUrl，如下所示：

final api = ModrinthApi(
  project: "my_test_project",
  baseUrl: "https://staging-api.modrinth.com/v2",
);

确保在使用完ModrinthApi实例后将其释放，以防止即使代码已完成运行仍然出现挂起问题。

api.dispose();

使用方法

搜索项目

可以通过facets进行搜索。如何使用facets的具体说明可以在Modrinth文档中找到。

仅搜索mod的示例：

api.search(
  facets: FacetListBuilder()
    ..and(
      Facet(FacetType.project_type, "mod"),
    ),
);

您还可以使用or()来添加多个facets，以过滤任何提供的facets。

例如，搜索任何可能是mod的项目（and()），并且目标版本为1.19或1.19.1（or()），并将结果限制为5个：

final quiteExact = await api.search(
  facets: FacetListBuilder()
    ..and(
      Facet(FacetType.project_type, "mod"),
    )
    ..or(
      [
        Facet(FacetType.versions, "1.19"),
        Facet(FacetType.versions, "1.19.1"),
      ],
    ),
  limit: 5,
);

通过ID或slug获取项目

final exactProject = await api.getProject("P7dR8mSH");
// 或者：
final exactProject = await api.getProject("fabric-api");

通过ID获取版本

final exactVersion = await api.getVersion("nOI7bsDO");

注意: 您不能使用slug，因为版本没有slug。

通过文件哈希获取版本

注意，计算文件哈希需要一个库，例如crypto，如下所示：

import "dart:io";
import "package:crypto/crypto.dart";
import "package:modrinth_api/modrinth_api.dart";

void main() async {
  final api = ModrinthApi(project: "my_test_project");

  final File f = File("my_mod_jar.jar");

  final List<int> input = await f.readAsBytes();

  final String sha = sha1.convert(input).toString();

  final Version foundVersion = await api.getVersionFromHash(sha);
}