1个稳定版本
| 3.8.2 | 2022年12月21日 |
|---|
83 在 机器人 中
500KB
7.5K SLoC
Rust API客户端用于tba-openapi-rust
概述
关于FIRST机器人竞赛队伍和活动的信息和统计数据。
认证
所有端点都需要在头部传递一个Auth Key X-TBA-Auth-Key。如果您还没有认证密钥，您可以从您的账户页面获取一个。
概述
此API客户端由OpenAPI Generator项目生成。通过使用远程服务器上的openapi-spec，您可以轻松生成API客户端。
- API版本：3.8.2
- 包版本：3.8.2
- 构建包：
org.openapitools.codegen.languages.RustClientCodegen
安装
将包放在名为 tba-openapi-rust 的目录下，并在 [dependencies] 下添加以下内容到 Cargo.toml
tba-openapi-rust = { path = "./tba-openapi-rust" }
API端点文档
所有URI都是相对于 https://www.thebluealliance.com/api/v3
| 类 | 方法 | HTTP请求 | 描述 |
|---|---|---|---|
| DistrictApi | get_district_events | GET /district/{district_key}/events | |
| DistrictApi | get_district_events_keys | GET /district/{district_key}/events/keys | |
| DistrictApi | get_district_events_simple | GET /district/{district_key}/events/simple | |
| DistrictApi | get_district_rankings | GET /district/{district_key}/rankings | |
| DistrictApi | get_district_teams | GET /district/{district_key}/teams | |
| DistrictApi | get_district_teams_keys | GET /district/{district_key}/teams/keys | |
| DistrictApi | get_district_teams_simple | GET /district/{district_key}/teams/simple | |
| DistrictApi | 按年份获取地区 | GET /districts/{year} | |
| DistrictApi | 获取事件地区积分 | GET /event/{event_key}/district_points | |
| DistrictApi | 获取队伍地区 | GET /team/{team_key}/districts | |
| EventApi | get_district_events | GET /district/{district_key}/events | |
| EventApi | get_district_events_keys | GET /district/{district_key}/events/keys | |
| EventApi | get_district_events_simple | GET /district/{district_key}/events/simple | |
| EventApi | 获取事件 | GET /event/{event_key} | |
| EventApi | 获取事件联盟 | GET /event/{event_key}/alliances | |
| EventApi | 获取事件奖项 | GET /event/{event_key}/awards | |
| EventApi | 获取事件地区积分 | GET /event/{event_key}/district_points | |
| EventApi | 获取事件洞察 | GET /event/{event_key}/insights | |
| EventApi | 获取事件比赛时间序列 | GET /event/{event_key}/matches/timeseries | |
| EventApi | 获取事件比赛 | GET /event/{event_key}/matches | |
| EventApi | 获取事件比赛键 | GET /event/{event_key}/matches/keys | |
| EventApi | 获取事件比赛简单信息 | GET /event/{event_key}/matches/simple | |
| EventApi | 获取事件OPR | GET /event/{event_key}/oprs | |
| EventApi | 获取事件预测 | GET /event/{event_key}/predictions | |
| EventApi | 获取事件排名 | GET /event/{event_key}/rankings | |
| EventApi | 获取事件简单信息 | GET /event/{event_key}/simple | |
| EventApi | 获取事件队伍 | GET /event/{event_key}/teams | |
| EventApi | 获取事件队伍键 | GET /event/{event_key}/teams/keys | |
| EventApi | 获取事件队伍简单信息 | GET /event/{event_key}/teams/simple | |
| EventApi | 获取事件队伍状态 | GET /event/{event_key}/teams/statuses | |
| EventApi | 按年份获取事件 | GET /events/{year} | |
| EventApi | 按年份获取事件键 | GET /events/{year}/keys | |
| EventApi | 按年份获取事件简单信息 | GET /events/{year}/simple | |
| EventApi | 获取队伍事件奖项 | GET /team/{team_key}/event/{event_key}/awards | |
| EventApi | 获取队伍事件比赛 | GET /team/{team_key}/event/{event_key}/matches | |
| EventApi | 获取队伍事件比赛键 | GET /team/{team_key}/event/{event_key}/matches/keys | |
| EventApi | 获取队伍事件比赛简单信息 | GET /team/{team_key}/event/{event_key}/matches/simple | |
| EventApi | 获取队伍事件状态 | GET /team/{team_key}/event/{event_key}/status | |
| EventApi | 获取队伍事件 | GET /team/{team_key}/events | |
| EventApi | 按年份获取队伍事件 | GET /team/{team_key}/events/{year} | |
| EventApi | 按年份获取队伍事件键 | GET /team/{team_key}/events/{year}/keys | |
| EventApi | 按年份获取队伍事件简单信息 | GET /team/{team_key}/events/{year}/simple | |
| EventApi | 获取队伍事件键 | GET /team/{team_key}/events/keys | |
| EventApi | 获取队伍事件简单信息 | GET /team/{team_key}/events/simple | |
| EventApi | 按年份获取队伍事件状态 | GET /team/{team_key}/events/{year}/statuses | |
| ListApi | get_district_events | GET /district/{district_key}/events | |
| ListApi | get_district_events_keys | GET /district/{district_key}/events/keys | |
| ListApi | get_district_events_simple | GET /district/{district_key}/events/simple | |
| ListApi | get_district_rankings | GET /district/{district_key}/rankings | |
| ListApi | get_district_teams | GET /district/{district_key}/teams | |
| ListApi | get_district_teams_keys | GET /district/{district_key}/teams/keys | |
| ListApi | get_district_teams_simple | GET /district/{district_key}/teams/simple | |
| ListApi | 获取事件队伍 | GET /event/{event_key}/teams | |
| ListApi | 获取事件队伍键 | GET /event/{event_key}/teams/keys | |
| ListApi | 获取事件队伍简单信息 | GET /event/{event_key}/teams/simple | |
| ListApi | 获取事件队伍状态 | GET /event/{event_key}/teams/statuses | |
| ListApi | 按年份获取事件 | GET /events/{year} | |
| ListApi | 按年份获取事件键 | GET /events/{year}/keys | |
| ListApi | 按年份获取事件简单信息 | GET /events/{year}/simple | |
| ListApi | 按年份获取队伍事件状态 | GET /team/{team_key}/events/{year}/statuses | |
| ListApi | 获取队伍 | GET /teams/{page_num} | |
| ListApi | 按年份获取队伍 | GET /teams/{year}/{page_num} | |
| ListApi | 按年份获取队伍键 | GET /teams/{year}/{page_num}/keys | |
| ListApi | 按年份获取队伍简单信息 | GET /teams/{year}/{page_num}/simple | |
| ListApi | 获取队伍键 | GET /teams/{page_num}/keys | |
| ListApi | 获取队伍简单信息 | GET /teams/{page_num}/simple | |
| MatchApi | 获取事件比赛时间序列 | GET /event/{event_key}/matches/timeseries | |
| MatchApi | 获取事件比赛 | GET /event/{event_key}/matches | |
| MatchApi | 获取事件比赛键 | GET /event/{event_key}/matches/keys | |
| MatchApi | 获取事件比赛简单信息 | GET /event/{event_key}/matches/simple | |
| MatchApi | 获取比赛 | GET /match/{match_key} | |
| MatchApi | 获取比赛简单信息 | GET /match/{match_key}/simple | |
| MatchApi | 获取比赛时间序列 | GET /match/{match_key}/timeseries | |
| MatchApi | 获取比赛斑马 | GET /match/{match_key}/zebra_motionworks | |
| MatchApi | 获取队伍事件比赛 | GET /team/{team_key}/event/{event_key}/matches | |
| MatchApi | 获取队伍事件比赛键 | GET /team/{team_key}/event/{event_key}/matches/keys | |
| MatchApi | 获取队伍事件比赛简单信息 | GET /team/{team_key}/event/{event_key}/matches/simple | |
| MatchApi | 按年份获取队伍比赛 | GET /team/{team_key}/matches/{year} | |
| MatchApi | 按年份获取队伍比赛键 | GET /team/{team_key}/matches/{year}/keys | |
| MatchApi | 按年份获取队伍比赛简单信息 | GET /team/{team_key}/matches/{year}/simple | |
| TbaApi | 获取状态 | GET /status | |
| TeamApi | get_district_rankings | GET /district/{district_key}/rankings | |
| TeamApi | get_district_teams | GET /district/{district_key}/teams | |
| TeamApi | get_district_teams_keys | GET /district/{district_key}/teams/keys | |
| TeamApi | get_district_teams_simple | GET /district/{district_key}/teams/simple | |
| TeamApi | 获取事件队伍 | GET /event/{event_key}/teams | |
| TeamApi | 获取事件队伍键 | GET /event/{event_key}/teams/keys | |
| TeamApi | 获取事件队伍简单信息 | GET /event/{event_key}/teams/simple | |
| TeamApi | 获取事件队伍状态 | GET /event/{event_key}/teams/statuses | |
| TeamApi | 获取队伍 | GET /team/{team_key} | |
| TeamApi | 获取队伍奖项 | GET /team/{team_key}/awards | |
| TeamApi | 按年份获取队伍奖项 | GET /team/{team_key}/awards/{year} | |
| TeamApi | 获取队伍地区 | GET /team/{team_key}/districts | |
| TeamApi | 获取队伍事件奖项 | GET /team/{team_key}/event/{event_key}/awards | |
| TeamApi | 获取队伍事件比赛 | GET /team/{team_key}/event/{event_key}/matches | |
| TeamApi | 获取队伍事件比赛键 | GET /team/{team_key}/event/{event_key}/matches/keys | |
| TeamApi | 获取队伍事件比赛简单信息 | GET /team/{team_key}/event/{event_key}/matches/simple | |
| TeamApi | 获取队伍事件状态 | GET /team/{team_key}/event/{event_key}/status | |
| TeamApi | 获取队伍事件 | GET /team/{team_key}/events | |
| TeamApi | 按年份获取队伍事件 | GET /team/{team_key}/events/{year} | |
| TeamApi | 按年份获取队伍事件键 | GET /team/{team_key}/events/{year}/keys | |
| TeamApi | 按年份获取队伍事件简单信息 | GET /team/{team_key}/events/{year}/simple | |
| TeamApi | 获取队伍事件键 | GET /team/{team_key}/events/keys | |
| TeamApi | 获取队伍事件简单信息 | GET /team/{team_key}/events/simple | |
| TeamApi | 按年份获取队伍事件状态 | GET /team/{team_key}/events/{year}/statuses | |
| TeamApi | 按年份获取队伍比赛 | GET /team/{team_key}/matches/{year} | |
| TeamApi | 按年份获取队伍比赛键 | GET /team/{team_key}/matches/{year}/keys | |
| TeamApi | 按年份获取队伍比赛简单信息 | GET /team/{team_key}/matches/{year}/simple | |
| TeamApi | 按标签获取队伍媒体 | GET /team/{team_key}/media/tag/{media_tag} | |
| TeamApi | 按标签和年份获取队伍媒体 | GET /team/{team_key}/media/tag/{media_tag}/{year} | |
| TeamApi | 按年份获取队伍媒体 | GET /team/{team_key}/media/{year} | |
| TeamApi | 获取队伍机器人 | GET /team/{team_key}/robots | |
| TeamApi | 获取队伍简单信息 | GET /team/{team_key}/simple | |
| TeamApi | 获取队伍社交媒体 | GET /team/{team_key}/social_media | |
| TeamApi | 获取队伍参与年份 | GET /team/{team_key}/years_participated | |
| TeamApi | 获取队伍 | GET /teams/{page_num} | |
| TeamApi | 按年份获取队伍 | GET /teams/{year}/{page_num} | |
| TeamApi | 按年份获取队伍键 | GET /teams/{year}/{page_num}/keys | |
| TeamApi | 按年份获取队伍简单信息 | GET /teams/{year}/{page_num}/simple | |
| TeamApi | 获取队伍键 | GET /teams/{page_num}/keys | |
| TeamApi | 获取队伍简单信息 | GET /teams/{page_num}/simple |
模型文档
- ApiStatus
- ApiStatusAppVersion
- Award
- AwardRecipient
- DistrictList
- 地区排名
- 地区排名事件积分内部
- 淘汰联盟
- 淘汰联盟备份
- 淘汰联盟状态
- 事件
- 事件地区积分
- 事件地区积分积分值
- 事件地区积分平局决断值
- 事件洞察
- 事件洞察2016
- 事件洞察2017
- 事件洞察2018
- 事件Oprs
- 事件排名
- 事件排名额外统计数据内部
- 事件排名排名内部
- 事件排名排序信息内部
- 事件简单
- 比赛
- 比赛联盟
- 比赛得分细分2015
- 比赛得分细分2015联盟
- 比赛得分细分2016
- 比赛得分细分2016联盟
- 比赛得分细分2017
- 比赛得分细分2017联盟
- 比赛得分细分2018
- 比赛得分细分2018联盟
- 比赛得分细分2019
- 比赛得分细分2019联盟
- 比赛得分细分2020
- 比赛得分细分2020联盟
- 比赛得分细分2022
- 比赛得分细分2022联盟
- 比赛简单
- 比赛简单联盟
- 比赛时间序列2018
- 比赛视频内部
- 媒体
- 队伍
- 队伍事件状态
- 队伍事件状态联盟
- 队伍事件状态联盟备份
- 队伍事件状态季后赛
- 队伍事件状态排名
- 队伍事件状态排名排名
- 队伍事件状态排名排序信息内部
- 队伍机器人
- 队伍简单
- 网络直播
- 胜负记录
- 斑马
- 斑马联盟
- 斑马队伍
要获取生成文档的访问权限，请使用
cargo doc --open
作者
依赖项
~4–16MB
~238K SLoC