2 个稳定版本

2023.9.30	2023 年 10 月 8 日
2023.6.24	2023 年 6 月 29 日
2.0.0	~~2023 年 6 月 29 日~~

#4 在 #ship

41 每月下载量

Apache-2.0

450KB
5.5K SLoC

Rust API 客户端用于 openapi

SpaceTraders 是一个开放宇宙的游戏和学习平台，提供一系列 HTTP 端点来控制舰队并在多人宇宙中进行探索。

该 API 使用 OpenAPI 进行文档说明。您可以直接在浏览器中发送第一个请求以检查游戏服务器状态。

{
  \"method\": \"GET\",
  \"url\": \"https://api.spacetraders.io/v2\",
}

与传统的游戏不同，SpaceTraders 没有第一方客户端或应用程序来玩游戏。相反，您可以使用 API 来构建自己的客户端，编写脚本来自动化您的船只，或者尝试社区构建的应用程序。

我们有一个 Discord 频道，您可以在那里分享项目、提问并获得其他玩家的帮助。

概述

此 API 客户端是由 OpenAPI Generator 项目生成的。通过使用来自远程服务器的 openapi-spec，您可以轻松生成 API 客户端。

API 版本：2.0.0
包版本：2.0.0
构建包：org.openapitools.codegen.languages.RustClientCodegen

安装

将软件包放入您的项目文件夹中名为 openapi 的目录下，并在 Cargo.toml 文件中添加以下内容，位于 [dependencies]

openapi = { path = "./openapi" }

API端点文档

所有URI均相对于 https://api.spacetraders.io/v2

类	方法	HTTP请求	描述
AgentsApi	get_agent	GET /agents/{agentSymbol}	获取公共代理
AgentsApi	get_agents	GET /agents	列出代理
AgentsApi	get_my_agent	GET /my/agent	获取代理
ContractsApi	accept_contract	POST /my/contracts/{contractId}/accept	接受合同
ContractsApi	deliver_contract	POST /my/contracts/{contractId}/deliver	交付货物到合同
ContractsApi	fulfill_contract	POST /my/contracts/{contractId}/fulfill	履行合同
ContractsApi	get_contract	GET /my/contracts/{contractId}	获取合同
ContractsApi	get_contracts	GET /my/contracts	列出合同
DefaultApi	get_status	GET /	获取状态
DefaultApi	register	POST /register	注册新代理
FactionsApi	get_faction	GET /factions/{factionSymbol}	获取派系
FactionsApi	get_factions	GET /factions	列出派系
FleetApi	create_chart	POST /my/ships/{shipSymbol}/chart	创建图表
FleetApi	create_ship_ship_scan	POST /my/ships/{shipSymbol}/scan/ships	扫描船只
FleetApi	create_ship_system_scan	POST /my/ships/{shipSymbol}/scan/systems	扫描系统
FleetApi	create_ship_waypoint_scan	POST /my/ships/{shipSymbol}/scan/waypoints	扫描航点
FleetApi	create_survey	POST /my/ships/{shipSymbol}/survey	创建调查
FleetApi	dock_ship	POST /my/ships/{shipSymbol}/dock	停靠船只
FleetApi	extract_resources	POST /my/ships/{shipSymbol}/extract	提取资源
FleetApi	extract_resources_with_survey	POST /my/ships/{shipSymbol}/extract/survey	使用调查提取资源
FleetApi	get_mounts	GET /my/ships/{shipSymbol}/mounts	获取配件
FleetApi	get_my_ship	GET /my/ships/{shipSymbol}	获取船只
FleetApi	get_my_ship_cargo	GET /my/ships/{shipSymbol}/cargo	获取船只货物
FleetApi	get_my_ships	GET /my/ships	列出船只
FleetApi	get_ship_cooldown	GET /my/ships/{shipSymbol}/cooldown	获取船只冷却时间
FleetApi	get_ship_nav	GET /my/ships/{shipSymbol}/nav	获取船只导航
FleetApi	install_mount	POST /my/ships/{shipSymbol}/mounts/install	安装配件
FleetApi	jettison	POST /my/ships/{shipSymbol}/jettison	抛弃货物
FleetApi	jump_ship	POST /my/ships/{shipSymbol}/jump	跳跃船只
FleetApi	navigate_ship	POST /my/ships/{shipSymbol}/navigate	导航船只
FleetApi	negotiate_contract	POST /my/ships/{shipSymbol}/negotiate/contract	谈判合同
FleetApi	orbit_ship	POST /my/ships/{shipSymbol}/orbit	轨道船只
FleetApi	patch_ship_nav	PATCH /my/ships/{shipSymbol}/nav	修补船只导航
FleetApi	purchase_cargo	POST /my/ships/{shipSymbol}/purchase	购买货物
FleetApi	purchase_ship	POST /my/ships	购买船只
FleetApi	refuel_ship	POST /my/ships/{shipSymbol}/refuel	加油船只
FleetApi	remove_mount	POST /my/ships/{shipSymbol}/mounts/remove	移除配件
FleetApi	sell_cargo	POST /my/ships/{shipSymbol}/sell	出售货物
FleetApi	ship_refine	POST /my/ships/{shipSymbol}/refine	船只精炼
FleetApi	货物转移	POST /my/ships/{shipSymbol}/transfer	转移货物
FleetApi	船体扭曲	POST /my/ships/{shipSymbol}/warp	扭曲船体
系统API	获取跃迁门	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}/jump-gate	获取跃迁门
系统API	获取市场	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}/market	获取市场
系统API	获取船厂	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}/shipyard	获取船厂
系统API	获取系统	GET /systems/{systemSymbol}	获取系统
系统API	获取系统航点	GET /systems/{systemSymbol}/waypoints	列出系统中的航点
系统API	获取系统列表	GET /systems	列出系统
系统API	获取航点	GET /systems/{systemSymbol}/waypoints/{waypointSymbol}	获取航点

模型文档

要获取存储箱生成的文档，请使用

cargo doc --open

作者

[email protected]

依赖项

~4–19MB
~252K SLoC