《Dinogen Online》API指南

本指南将向你展示《Dinogen Online》API的基本使用方法，并提供一些使用示例。 简介 本指南旨在帮助你使用《Dinogen Online》API来创建各类支持《Dinogen Online》社区的第三方应用！ API说明 API通过网络请求格式使用。基础地址可能会不时更改，但格式始终为：apiAddress/api/getCall?params。获取玩家数据的示例如下：apiAddress/api/getPlayer?username=BLT。点击此类链接会返回JSON格式数据。所有API调用均返回JSON。如果你不熟悉JSON数据存储格式，可以参考相关JSON解释资料。要使用此API，您需要具备从Web请求服务器获取数据、JSON格式化以及JSON处理的基础知识。 发起获取请求 掌握所有基础知识后，就可以发起您的第一个获取请求了。为简单起见，我将通过JavaScript给出示例。请注意，从Web服务器获取文件的方式可能因您使用的编程语言和平台而有所不同。 在JS中发起获取请求，您需要从一个异步函数开始，如下所示： async function getPlayerData(address, uname) { } 请注意，此函数有两个参数：address和uname。address参数为函数提供当前API地址（稍后将对此进行讨论），而uname参数则为函数提供你希望获取其数据的玩家的用户名。 接下来，让我们添加一个fetch调用及其相关依赖： async function getPlayerData(address, uname) { fetch(address + 'api/getPlayer?username=' + uname).then( function (response) { return response.json(); }).then(function (obj) { console.log(obj); doStuff(obj); }).catch(function (error) { console.error(error); }); } 哇，这内容有点多。让我们逐步分析。首先，我们调用内置的JS函数“fetch”，传入我们想要从中获取数据的地址。注意这个地址以参数“address”开头，后面跟着字符串“api/getPlayer?”中间是“username='，末尾是“uname”参数。中间部分是关键内容所在。“api/”是地址的另一部分，目前不在address.txt文件中（稍后详述）。“getPlayer”是其中一个调用的名称，具体是返回玩家数据JSON的调用。“?username=”是该调用所需的参数之一。这是你将进行的所有API获取调用的基本设置。 之后我们调用3个不同的通用函数。第一个将响应转换为可读的JSON，并将其返回给第二个通用函数。第二个步骤记录JSON对象（本质上与JS对象相同），然后使用该数据调用一个函数，在函数中对数据进行所需的任何处理。最后的通用部分捕获任何错误并将其记录到控制台。 现在有了这个，是时候让你的获取函数在主API地址不可用时也能工作了。 访问API地址 这部分非常简单。我们使用与之前几乎相同的函数： 异步函数getAddress（用户名）{ 获取（'外部链接'）.然后（函数（响应）{ 返回响应.文本（）； }）.然后（函数（对象）{ 控制台.日志（对象）； 获取玩家数据（字符串（对象），用户名）； }）.捕获（函数（错误）{ 控制台.不过这一次，我们会访问一个不同的地址，并将响应转换为字符串，然后将其发送到之前创建的函数。完成所有这些步骤后，当地址发生更改时，你的系统就会更新该地址。现在让我们继续处理这些数据。 处理数据 接下来我们将对数据进行处理。首先完善之前的函数： function doStuff(data) { var user = document.createElement('h1'); user.id = "user"; document.getElementById('dataDiv').appendChild(user); } 在这里，我们创建了一个元素并将其添加到DOM中。这将显示我们请求的用户名。让我们为它添加一些数据： function doStuff(data) { var user = document.createElement('h1'); user.id = "user"; user.如果你不熟悉点表示法，在这种情况下，它表示对象层级。例如，data.username 表示你想要获取键“username”的值。这与 data['username'] 相同。另一个例子是 data.data.level。现在我们在层级中添加了另一层。我们要获取键“data”的值，它是另一个对象，然后我们获取键“level”的值，这是一个整数。这与 data['data']['level'] 相同。通过这种方式，只要你知道要获取什么数据，访问 API 返回的任何 JSON 中的所有数据都非常简单。 示例 目前有两个 API 使用示例。第一个是一个数据查询网站。第二个是《Dinogen Online》开发者贾斯汀制作的Discord机器人。如果您对API有任何疑问或问题，欢迎在Discord上联系我或贾斯汀！