LeagueAPI - 文档 League API是一个Swift编写的《英雄联盟》框架。它为将《英雄联盟》的数据轻松地集成到iOS、WatchOS、TvOS、MacOS和Linux应用程序提供了一种简单的方式。
它被设计成易于使用,利用Swift枚举的优势。它还包括一些内部机制,以处理任何API密钥速率限制。
支持《英雄联盟》、《冲突》、《战争艺术: Teamfight Tactics》和《英雄联盟:激流峡谷》的API
🚧 安装🚧
CocoaPods
- 进入您的项目,位于YourProject.xcodeproj所在的文件夹。
- 运行
pod init
。 - 打开Podfile进行编辑(请不要使用Textedit,因为它会插入无效字符)。
- 在“use_frameworks!”下面写上
pod 'LeagueAPI'
。 - 运行
pod install
。 - 创建了一个YourProject.xcworkspace文件。从现在开始,您应该打开这个文件而不是YourProject.xcodeproj文件。
- 如果您可以在项目中不出现编译错误写上
import LeagueAPI
,那么您就完成了。干得漂亮!如果不行,您可以打开一个issue,以便我可以查看您的问题。
Carthage
- 进入您的项目,位于YourProject.xcodeproj所在的文件夹。
- 创建一个名为Cartfile的文件,并在其中写入
github "Kelmatou/LeagueAPI"
。 - 在终端中运行
carthage bootstrap --platform iOS --use-xcframeworks
(对于Xcode < 12,您不一定需要添加 --use-xcframeworks)。 - 打开YourProject.xcodeproj,并转到目标的一般设置。
- 在预置的二进制文件中添加LeagueAPI.framework(位于Carthage/Build/LeagueAPI.xcframework)。
- 如果您能在项目中不出现编译错误写上
import LeagueAPI
,那么您就完成了。干得漂亮!如果不行,请参阅下面的故障排除部分。
用户手册
- 在此处下载发布版本(或者通过GitHub内容,但可能是包含实验性更改的版本)。
- 打开 LeagueAPI/LeagueAPI.xcodeproj。
- 选择LeagueAPI-Release方案,并为您选择的平台(模拟器或iOS通用设备)进行构建(播放按钮或cmd+b)。
- 在项目导航器中,您会发现一个名为Products的文件夹,其中包含 LeagueAPI.framework。将其拖放到您的项目通用设置 -> 嵌入式二进制文件中。
- 如果您能在项目中编写
import LeagueAPI
而不出现编译错误,那么您就成功了。做得很好!如果在这一步遇到问题,请检查您的项目目标(模拟器或iOS设备)是否与LeagueAPI.framework选择相同的平台。如果这无法解决问题,请阅读下面的故障排除部分。
故障排除
本节列出了在您的项目中使用 import LeagueAPI
的主要解决方案。
- 返回您的项目,目标设置 -> 构建设置 -> 框架搜索路径,然后添加LeagueAPI.framework的路径。
如果以上任何一种方法都没有帮到您,请打开一个问题来描述您的问题,我会尽快检查。
📋 要求📋
📦 最低版本📦
🔑 Riot API Key🔑
要使用LeagueAPI,您需要一个Riot API Key。您可以通过访问 https://developer.riotgames.com 获取。创建一个账户,然后您会在仪表板上生成您的密钥。默认情况下,Riot会生成一个'Development Key',它将在24小时后过期。当您的应用程序准备好部署并且遵守Riot API使用条件时,您可以申请'Production Key'。请注意,您需要同意 Riot API使用政策。
😈 血战成名😈
开始使用此框架需要您通过编写以下内容来创建LeagueAPI的一个实例
let league = LeagueAPI(APIToken: "*INSERT YOUR KEY HERE*")
现在,您可以在任何地方使用此实例,您不应该重新创建LeagueAPI变量。
🧐 然后呢?🧐
LeagueAPI分为4个不同的API
- Riot API
- 英雄联盟API
- 团队竞技策略API
- 乱战纪元API
Riot API
Riot API返回关于每名玩家的Riot Games账户信息。
您可以通过 league.riotAPI
访问,从这里您将访问为
英雄联盟API
英雄联盟API包含与英雄联盟游戏相关的方法。
可以通过league.lolAPI
访问。从这里,您可以获取关于以下内容的信息:
英雄联盟
- 召唤师
- 观众/直播游戏
- 排位/联赛
- 排位/联赛经验
- 比赛历史
- 英雄精通
- 英雄
- 服务器状态
- 验证码
- 锦标赛占位符
- 锦标赛
- 补丁
- 个人资料图标
- 物品
- 召唤师技能
- 符文
- 排位段位
- 英雄详细信息 - 已从3.0.0版本中弃用
冲突
云顶之弈
云顶之弈API包含与云顶之弈游戏相关的方法。
可以通过league.tftAPI
访问。从这里您可以找到以下信息:
跑跑大陆传说
跑跑大陆传说API包含与《跑跑大陆传说》游戏相关的方法。
可以通过league.lorAPI
访问。从这里您可以获取以下信息:
完整文档在此处可用 在这里。
请注意,文档中只会显示最新版本的内容。查看旧版本LeagueAPI的较旧版本,请看之前的修订版本。
让LeagueAPI成长起来!
如果您觉得有任何东西缺失,请不要犹豫,提出问题或创建拉取请求。这可能会帮助未来的开发者。如果您发现LeagueAPI很有用或使用起来很酷,请不要犹豫,通过添加来推广它
贡献者
Antoine Clop (Kelmatou)
Ronan Cendrier (Hanoki)
Ammon Parry (AmmonP)
Sandi Karajic (SKarajic)