tkhamez/swagger-eve-php

为EVE Online (ESI)提供的OpenAPI客户端库

10.0.1 2024-07-28 20:53 UTC

README

Packagist Downloads

OpenAPIClient-php

EVE Online的OpenAPI。

此客户端是从"下划线路由"生成的。

它包含两个补丁,用于删除枚举属性和最大项目验证。CCP表示,枚举属性的扩展不再会导致破坏性更改,请参阅ESI变更日志,他们还更改了最大项目,而没有增加端点版本号。

自1.0.0以来的版本方案
  • 补丁:从新的swagger.json文件生成客户端,参考esi-issues/changelog.md(注意,然而,那里的日期并不总是正确的)和/或使用生成库的新补丁版本生成。
  • 次要:切换到生成库的新次要版本。
  • 主要:切换到生成库的新主要版本,切换到另一个生成库或另一个破坏性更改。

有关生成库更改,请参阅https://github.com/OpenAPITools/openapi-generator/releases

除API更新之外的其他显著更改

10.0.0

  • 添加补丁以删除包含比声明更多元素的响应的异常。

8.0.0

  • 将最低PHP要求提高到7.4

7.1.0

  • 需要Guzzle HTTP客户端^7.3。

7.0.0

  • 将最低PHP要求提高到7.3

6.1.0

  • 需要guzzlehttp/psr7 < version 2(此库使用在2.0中删除的函数)。

5.0.0

  • 添加补丁以允许Guzzle HTTP客户端^7.2与^6.2(7.2需要PHP ^7.2.5 || ^8.0)一起使用。

4.0.0

  • 删除以前的补丁。
  • 添加删除所有枚举属性验证的补丁。

3.2.0

  • 添加DISABLE_TYPE_VALIDATION.patch:禁用角色通知类型的验证(CCP添加新类型而不会增加端点版本或将其包含在变更日志中)。

3.1.0

  • 添加TYPE_WAR_ADOPTED2.patch:通知类型"WarAdopted "在swagger_latest.json文件和在ESI的响应中有一个空格在末尾。但生成的客户端不知何故删除了它,因此验证失败。此补丁添加"WarAdopted "。

安装与使用

要求

PHP 7.4及更高版本。也应适用于PHP 8.0。

Composer

要通过Composer安装绑定,请将以下内容添加到composer.json

{
  "require": {
    "tkhamez/swagger-eve-php": "10.0.1"
  }
}

然后运行composer install

手动安装

下载文件并包含autoload.php

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

入门

请遵循安装程序,然后运行以下命令

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new Swagger\Client\Eve\Api\AllianceApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$datasource = 'tranquility'; // string | The server name you would like data from
$if_none_match = 'if_none_match_example'; // string | ETag from a previous request. A 304 will be returned if this matches the current ETag

try {
    $result = $apiInstance->getAlliances($datasource, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AllianceApi->getAlliances: ', $e->getMessage(), PHP_EOL;
}

API端点

所有URI均相对于https://esi.evetech.net

模型

授权

为API定义的认证方案

evesso

  • 类型: OAuth
  • 流程: implicit
  • 授权URL: https://login.eveonline.com/v2/oauth/authorize
  • 作用域:
    • esi-alliances.read_contacts.v1: EVE SSO作用域 esi-alliances.read_contacts.v1
    • esi-assets.read_assets.v1: EVE SSO作用域 esi-assets.read_assets.v1
    • esi-assets.read_corporation_assets.v1: EVE SSO作用域 esi-assets.read_corporation_assets.v1
    • esi-bookmarks.read_character_bookmarks.v1: EVE SSO作用域 esi-bookmarks.read_character_bookmarks.v1
    • esi-bookmarks.read_corporation_bookmarks.v1: EVE SSO作用域 esi-bookmarks.read_corporation_bookmarks.v1
    • esi-calendar.read_calendar_events.v1: EVE SSO作用域 esi-calendar.read_calendar_events.v1
    • esi-calendar.respond_calendar_events.v1: EVE SSO作用域 esi-calendar.respond_calendar_events.v1
    • esi-characters.read_agents_research.v1: EVE SSO作用域 esi-characters.read_agents_research.v1
    • esi-characters.read_blueprints.v1: EVE SSO作用域 esi-characters.read_blueprints.v1
    • esi-characters.read_contacts.v1: EVE SSO作用域 esi-characters.read_contacts.v1
    • esi-characters.read_corporation_roles.v1: EVE SSO作用域 esi-characters.read_corporation_roles.v1
    • esi-characters.read_fatigue.v1: EVE SSO作用域 esi-characters.read_fatigue.v1
    • esi-characters.read_fw_stats.v1: EVE SSO作用域 esi-characters.read_fw_stats.v1
    • esi-characters.read_loyalty.v1: EVE SSO作用域 esi-characters.read_loyalty.v1
    • esi-characters.read_medals.v1: EVE SSO作用域 esi-characters.read_medals.v1
    • esi-characters.read_notifications.v1: EVE SSO作用域 esi-characters.read_notifications.v1
    • esi-characters.read_opportunities.v1: EVE SSO作用域 esi-characters.read_opportunities.v1
    • esi-characters.read_standings.v1: EVE SSO作用域 esi-characters.read_standings.v1
    • esi-characters.read_titles.v1:EVE SSO 范围 esi-characters.read_titles.v1
    • esi-characters.write_contacts.v1:EVE SSO 范围 esi-characters.write_contacts.v1
    • esi-clones.read_clones.v1:EVE SSO 范围 esi-clones.read_clones.v1
    • esi-clones.read_implants.v1:EVE SSO 范围 esi-clones.read_implants.v1
    • esi-contracts.read_character_contracts.v1:EVE SSO 范围 esi-contracts.read_character_contracts.v1
    • esi-contracts.read_corporation_contracts.v1:EVE SSO 范围 esi-contracts.read_corporation_contracts.v1
    • esi-corporations.read_blueprints.v1:EVE SSO 范围 esi-corporations.read_blueprints.v1
    • esi-corporations.read_contacts.v1:EVE SSO 范围 esi-corporations.read_contacts.v1
    • esi-corporations.read_container_logs.v1:EVE SSO 范围 esi-corporations.read_container_logs.v1
    • esi-corporations.read_corporation_membership.v1:EVE SSO 范围 esi-corporations.read_corporation_membership.v1
    • esi-corporations.read_divisions.v1:EVE SSO 范围 esi-corporations.read_divisions.v1
    • esi-corporations.read_facilities.v1:EVE SSO 范围 esi-corporations.read_facilities.v1
    • esi-corporations.read_fw_stats.v1:EVE SSO 范围 esi-corporations.read_fw_stats.v1
    • esi-corporations.read_medals.v1:EVE SSO 范围 esi-corporations.read_medals.v1
    • esi-corporations.read_standings.v1:EVE SSO 范围 esi-corporations.read_standings.v1
    • esi-corporations.read_starbases.v1:EVE SSO 范围 esi-corporations.read_starbases.v1
    • esi-corporations.read_structures.v1:EVE SSO 范围 esi-corporations.read_structures.v1
    • esi-corporations.read_titles.v1:EVE SSO 范围 esi-corporations.read_titles.v1
    • esi-corporations.track_members.v1:EVE SSO 范围 esi-corporations.track_members.v1
    • esi-fittings.read_fittings.v1:EVE SSO 范围 esi-fittings.read_fittings.v1
    • esi-fittings.write_fittings.v1:EVE SSO 范围 esi-fittings.write_fittings.v1
    • esi-fleets.read_fleet.v1:EVE SSO 范围 esi-fleets.read_fleet.v1
    • esi-fleets.write_fleet.v1:EVE SSO 范围 esi-fleets.write_fleet.v1
    • esi-industry.read_character_jobs.v1:EVE SSO 范围 esi-industry.read_character_jobs.v1
    • esi-industry.read_character_mining.v1:EVE SSO 范围 esi-industry.read_character_mining.v1
    • esi-industry.read_corporation_jobs.v1:EVE SSO 范围 esi-industry.read_corporation_jobs.v1
    • esi-industry.read_corporation_mining.v1:EVE SSO 范围 esi-industry.read_corporation_mining.v1
    • esi-killmails.read_corporation_killmails.v1:EVE SSO 范围 esi-killmails.read_corporation_killmails.v1
    • esi-killmails.read_killmails.v1:EVE SSO 范围 esi-killmails.read_killmails.v1
    • esi-location.read_location.v1:EVE SSO 范围 esi-location.read_location.v1
    • esi-location.read_online.v1:EVE SSO 范围 esi-location.read_online.v1
    • esi-location.read_ship_type.v1:EVE SSO 范围 esi-location.read_ship_type.v1
    • esi-mail.organize_mail.v1:EVE SSO 范围 esi-mail.organize_mail.v1
    • esi-mail.read_mail.v1:EVE SSO 范围 esi-mail.read_mail.v1
    • esi-mail.send_mail.v1:EVE SSO 范围 esi-mail.send_mail.v1
    • esi-markets.read_character_orders.v1:EVE SSO 范围 esi-markets.read_character_orders.v1
    • esi-markets.read_corporation_orders.v1:EVE SSO 范围 esi-markets.read_corporation_orders.v1
    • esi-markets.structure_markets.v1:EVE SSO 范围 esi-markets.structure_markets.v1
    • esi-planets.manage_planets.v1:EVE SSO 范围 esi-planets.manage_planets.v1
    • esi-planets.read_customs_offices.v1:EVE SSO 范围 esi-planets.read_customs_offices.v1
    • esi-search.search_structures.v1:EVE SSO 范围 esi-search.search_structures.v1
    • esi-skills.read_skillqueue.v1:EVE SSO 范围 esi-skills.read_skillqueue.v1
    • esi-skills.read_skills.v1:EVE SSO 范围 esi-skills.read_skills.v1
    • esi-ui.open_window.v1:EVE SSO 范围 esi-ui.open_window.v1
    • esi-ui.write_waypoint.v1:EVE SSO 范围 esi-ui.write_waypoint.v1
    • esi-universe.read_structures.v1:EVE SSO 范围 esi-universe.read_structures.v1
    • esi-wallet.read_character_wallet.v1:EVE SSO 范围 esi-wallet.read_character_wallet.v1
    • esi-wallet.read_corporation_wallets.v1:EVE SSO 范围 esi-wallet.read_corporation_wallets.v1

测试

要运行测试,请使用

composer install
vendor/bin/phpunit

作者

关于此包

此PHP包是由 OpenAPI Generator 项目自动生成的

  • API版本:1.25
    • 生成器版本:7.6.0
  • 构建包:org.openapitools.codegen.languages.PhpClientCodegen