1 个不稳定版本
| 0.0.1 | 2023年6月5日 |
|---|
#64 在 #interfacing
78KB
1K SLoC
eclipsis-rs 的 Rust API 客户端
公共 API，可用于您想要使用的任何地方。这些 API 有限制访问频率，因此请尽量减少请求。
API 的未来使用将需要 API 密钥。
API 密钥
API 密钥需要与每个请求一起传递。有了 API 密钥，您还应该遵守以下指南
- 不要分享您的 API 密钥。
- 数据可以保留最长 30 天（这是为了遵守 GDPR 指引）。
您可以使用客户端登录/注销 API 将 API 密钥保存到浏览器中，以便方便使用。
您可以通过询问 Eclipsis discord 中的工作人员来获取 API 密钥。
概述
此 API 客户端由 OpenAPI Generator 项目生成。通过使用远程服务器上的 openapi-spec，您可以轻松生成 API 客户端。
- API 版本：3.0.0
- 包版本：3.0.0
- 构建包：
org.openapitools.codegen.languages.RustClientCodegen
安装
将包放在名为 eclipsis-rs 的目录中，并将以下内容添加到 Cargo.toml 中的 [dependencies]
eclipsis-rs = { path = "./eclipsis-rs" }
API 端点文档
所有 URI 都是相对于 https://api.xethlyx.com
| 类 | 方法 | HTTP 请求 | 描述 |
|---|---|---|---|
| ClientApi | client_delete | DELETE /client/delete | 删除 |
| ClientApi | client_info | GET /client/info | 信息 |
| ClientApi | client_login | POST /client/login | 登录 |
| ClientApi | client_logout | POST /client/logout | 注销 |
| MatchApi | get_match | GET /eclipsis/match/{matchId} | 获取比赛数据 |
| UserApi | get_user_delta | GET /eclipsis/user/delta/{userId} | 获取评分变动 |
| UserApi | get_user_matches | GET /eclipsis/user/matches/{userId} | 获取比赛 |
| UserApi | get_user_overview | GET /eclipsis/user/overview/{userId} | 获取概览 |
| UserApi | get_user_playtime | GET /eclipsis/user/playtime/{userId} | 获取游戏时间 |
| UserApi | get_user_rating | GET /eclipsis/user/rating/{userId} | 获取评分 |
| UserApi | get_user_status | POST /eclipsis/user/status | 获取基本状态 |
| UserApi | get_user_teammates | GET /eclipsis/user/teammates/{userId} | 获取队友 |
模型文档
- ApiError
- ApiKeyData
- Match
- MatchPlayer
- MatchTeam
- Success
- Success1
- Success10
- Success10ValueInnerInner
- Success11
- Success2
- Success3
- 成功4
- 成功5
- 成功6
- 成功7
- 成功7ValueInnerInnerInner
- 成功8
- 成功9
要获取crate生成的文档，请使用
cargo doc --open
作者
依赖
~4–16MB
~243K SLoC