npm 包 speedrunapi 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

Speedrunapi 是针对游戏速通记录网站 speedrun.com 的 API 封装库，在实现一个以 speedrun.com 为数据源的项目时，这个库非常有用。

安装

首先需要在项目中安装此 npm 包。

npm install speedrunapi

使用

在引用此库前，需要先申请到 speedrun.com 的 API key。

const SpeedrunAPI = require('speedrunapi');

const api = new SpeedrunAPI('YOUR_API_KEY');

获取游戏列表

api.games()
  .then(data => console.log('games', data))
  .catch(err => console.error(err));

获取某个游戏的分类

api.categories('game_id')
  .then(data => console.log('categories', data))
  .catch(err => console.error(err));

获取某个游戏分类的排行榜

api.leaderboards('game_id', 'category_id')
  .then(data => console.log('leaderboards', data))
  .catch(err => console.error(err));

获取某个游戏的变体

api.variables('game_id')
  .then(data => console.log('variables', data))
  .catch(err => console.error(err));

搜索游戏

api.search(game_name)
  .then(data => console.log('search', data))
  .catch(err => console.error(err));

示例代码

以下是一个获取某个游戏排行榜前 10 名玩家以及他们的成绩和链接的代码示例：

-- -------------------- ---- -------
--------------------------- --------------
  ---------- -- -
    ----- - ---- - - ----------
    ------------- --------------- -- -
      ----- - ------ ---- - -------- ----- - - - ----
      ----- ------ - -----------
      ----- - ----- --- - - -------
      ------------------ ----- -------------- -----
    ---
  --
  ---------- -- --------------------

结语

通过本教程，您可以了解 Speedrunapi 库的安装和使用方法，并学习如何获取游戏列表、游戏分类、排行榜、变体以及如何搜索游戏。

此外，根据所需数据的类型和具体情况，您还可以查看 speedrun.com 的官方文档来了解更多有关其 API 的详细信息。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/60055d3381e8991b448daf28