Intro 简介

ArkAPI 是由 ArkAlliance 发起的明日方舟资源公共 API，皆在为明日方舟工具站生态提供稳定、易于接入且面向用户体验优化的 API 服务。

ArkAPI 现处于早期开发阶段，欢迎创建 Issues 或/和 Pull Requests 与我们一起完善 ArkAPI。

Guide 接入指南

ArkAPI 将提供两种 API 接入方式：RESTful API 和 GraphQL API (什么是 GraphQL?)。

两种接入方式所提供的 API 服务内容均相同，但 GraphQL API 提供了更为强大的查询功能。

接入指南仍在建设中，敬请期待

Development 开发与贡献指南

Setup

• Node.js (>= 18)
  • 强烈建议使用 Node.js 版本管理工具。fnm (推荐)、nvm 均为不错的方案。通过 fnm 或 nvm 均可直接引用项目中的 .nvmrc 文件中的版本号安装正确版本的 Node.js: fnm install 或 nvm install

Note

项目使用 pnpm 进行依赖管理；不当使用包管理器可能导致项目依赖不一致，从而导致项目无法正常运行，因此请务必使用 pnpm 进行所有操作。

Install

$ pnpm install

Initialize database schema

$ pnpx prisma migrate dev

Running the app

# development
$ pnpm start

# watch mode
$ pnpm start:dev

# production mode
$ pnpm start:prod

Tests

# unit tests
$ pnpm test

# e2e tests
$ pnpm test:e2e

# test coverage
$ pnpm test:cov

License 协议

ArkAPI 源代码以 AGPL-3.0 开源。

ArkAPI 的服务内容以 CC BY-NC 4.0 协议开放。

Security Disclosure 安全漏洞披露

如果您发现了安全漏洞，请发送 E-mail 至 me at galvingao dot com，我们将尽快处理。ArkAPI 感谢您对其安全的关注，并希望您能遵守以下安全披露原则：

• 请不要在收到我们已修复漏洞的回复前公开披露安全漏洞；
• 请在安全漏洞报告中提供尽可能多的信息，例如漏洞的影响范围、复现步骤、漏洞的危害等；
• 请同时在安全漏洞报告中提供测试此漏洞时所使用的环境信息，例如 User-Agent、鉴权信息、IP 地址等，以便我们更快地定位问题。

Contributing 贡献

ArkAPI 欢迎任何形式的贡献，包括但不限于：

• 提交目的明确、描述清晰的 Issues
• 提交 Pull Requests

Credits 致谢

• Kengxxiao/ArknightsGameData 提供 API 所需的原始数据