介绍
hordes-api-wrapper 是一款基于 TypeScript 编写的轻量级 Node.js 包，它提供了一系列简单易用的 API，让前端开发者可以轻松地在自己的项目中集成游戏《兽族崛起》的相关数据。
在本文章中，我们将介绍 hordes-api-wrapper 的基本使用方式，包括安装、相关概念、API 的具体使用以及示例代码等。
安装
在安装前，请确保您已经安装了 Node.js 的环境。
Hordes-api-wrapper 可以使用 npm 或者 yarn 进行安装。可以通过以下命令进行安装：
npm install @dragovorn/hordes-api-wrapper # 或者 yarn add @dragovorn/hordes-api-wrapper
概念
在使用 hordes-api-wrapper 之前，需要了解一些相关的概念。
User Agent
User Agent 是一种标识浏览器和操作系统等信息的字符串，由于《兽族崛起》API 对其包含的 User Agent 进行了限制，因此需要在使用时传入一个有效的 User Agent。
例如：
const client = new HordesApiClient('Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.36');频率限制
《兽族崛起》API 为了保护自身的资源，设置了一定的频率限制。hordes-api-wrapper 会自动处理频率限制问题，如果请求超过了允许的次数，则会自动等待一段时间后再发起请求。
远程调试
在进行开发时，可以通过使用环境变量 HORDES_REMOTE 开启远程调试模式，这样可以通过浏览器查看 API 的返回值，进一步快速开发和调试。
例如：
HORDES_REMOTE=1 npm start
浏览器访问 http://localhost:9222/json/list 即可查看请求信息。
API
hordes-api-wrapper 提供了几种常用的 API。下面我们将详细介绍 API 的使用方式。
HordesApiClient
HordesApiClient 是一个基本的 API 客户端，它可以用于向《兽族崛起》API 发起请求，并返回相应的数据。
构造函数
constructor(userAgent: string, requestInterval?: number)
构造函数中需要传入一个有效的 User Agent，以及请求时间间隔（不一定需要）。
getMapData
async getMapData(): Promise<MapData[]>;
getMapData 是用于获取游戏地图信息的 API。
例如：
const client = new HordesApiClient(userAgent); const mapData = await client.getMapData(); console.log(mapData);
getMapData 的返回值是一个数组，包含了所有游戏地图的信息。
HordesApiCachedClient
这是一个对 HordesApiClient 封装，把获取得到的游戏数据缓存到了内存中，为避免 API 请求次数过多，增加程序负担。
构造函数
constructor(userAgent: string, cacheTtlInSeconds: number, requestInterval?: number)
缓存时间 cacheTtlInSeconds 表示缓存失效的时间（秒）。
getCellData
async getCellData(x: number, y: number): Promise<CellData>;
getCellData 是用于获取指定坐标上的地图数据的 API。
例如：
const client = new HordesApiCachedClient(userAgent, 60); const cellData = await client.getCellData(100, 100); console.log(cellData);
getCellData 的返回值是一个 JSON 对象，包含了地图坐标上的所有信息。
示例代码
-- -------------------- ---- ------- ------ - --------------- - ---- -------------------------------- ----- --------- - ------------ -------- -- ----- ------ ---- ------------------ ------- ---- ------ -------------------- --------------- ----- -------- ----- - ---------------------- ----- ------- - ----- -------------------- --------------------- -------------------------- ----- ------ - --- --------------------------- ----- -------- - ----- ----------------------- ----- ---------------------- - ---------------------------
结语
本文主要介绍了 hordes-api-wrapper 的使用方法，包括安装、相关概念、API 的具体使用以及示例代码等。希望本文可以帮助前端开发者更快更好地使用 hordes-api-wrapper 进行开发。如果您有任何问题或建议，请在评论区留言，我们将尽快回复。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6005580b81e8991b448d52f2