jaytaph/spacetraders

SpaceTraders.io API 的 PHP 客户端

dev-main 2023-05-22 18:47 UTC

This package is auto-updated.

Last update: 2024-09-22 21:26:10 UTC


README

包含一个用于您自己的应用程序的 API

每个 API 调用包括以下内容

  • 实例化一个 API 命令。

    例如: Jaytaph\Spacetraders\Api\Command\Fleet\ListCommand(1, 20)。每个命令可以有多个参数,这取决于调用。例如,列表命令有一个页面号和限制参数来获取指定页面。

  • 创建一个 API 实例。构造函数接受一个布尔参数,指示是否应从 .token 文件中检索令牌。如果不是,您可以使用 $api->setToken($token) 设置它。然后令牌将用于授权头。

  • 接下来,执行给定的命令。它将返回一个 ApiResponse 对象。此对象包含响应数据和状态码,可用于检查调用是否成功。

  • 解析响应

示例

  $command = ListCommand(page: 1, limit: 20);
  $api = new Api(retrieveToken: true);
  $response = $api->execute($command);

  $response = ListResponse::fromJson($response->data);
  foreach ($response->ships as $ship) {
     print "You have a ship named {$ship->symbol}\n"; 
  }

请阅读 spacetraders.io 入门文档以使用 API。大部分内容那时就会变得有意义。