README

PHP API 用于消费国家铁路历史服务性能 API。

入门指南

以下说明将帮助您在本地机器上运行项目副本，以便进行开发和测试。同时还包括在您的项目中消费 API 的说明。

安装

要在您的项目中使用 NRE 数据包，请通过 composer 引入此包。

composer.phar require trainjunkies/hsp

要查询 API，请使用从国家铁路数据包获取的 API 凭证配置 Client。

<?php

include __DIR__ . '/vendor/autoload.php';

$client = \Trainjunkies\Hsp\ClientFactory::create(
    'USERNAME',
    'PASSWORD'
);

try {
    $result = $client->getServiceDetails('SOME-RID-VALUE');
} catch (Exception $e) {
    die($e->getMessage());
}

开发和测试安装

为了开发，您需要在您的机器上安装 Docker 和 Git。

git clone git@github.com:trainjunkies/hsp.git

并在您克隆项目的目录中...

docker-compose up -d --build

这将提供 hsp 容器，安装所需的 PHP 库和 Xdebug。

运行测试

解释如何运行此系统的自动测试

单元/规格测试

docker-compose run --rm hsp bin/phpspec r

集成套件

要查询有效的服务详细信息请求对 HSP API

docker-compose run --rm hsp bin/phpunit

代码风格检查器

为了保持一致性...

docker-compose run --rm hsp bin/phpcs --standard=PSR2 src/

使用 Xdebug 调试

默认情况下，Xdebug 在容器中启用，并在 docker-compose.yml 中指定设置

默认情况下，Xdebug 将尝试连接到 10.254.254.254 的端口 9000。为了方便起见，您可以使用以下说明将 127.0.0.1 别名为此地址。

DockerForMac

sudo ifconfig lo0 alias 10.254.254.254

Ubuntu

sudo ifconfig lo:1 10.254.254.254 up

现在您应该能够通过将 PHPStorm 设置为监听连接来使用 Xdebug。

注意：路径映射应该是 /var/www 到您的项目目录。注意：可能还需要对 IDE 进行进一步配置以监听传入的 Xdebug 连接。以下是在 PHPStorm 中的示例，需要为 trainjunkies_hsp_dev_container 定义一个 "服务器"。

docker-compose run --rm -e PHP_IDE_CONFIG="serverName=trainjunkies_hsp_dev_container" hsp bin/phpspec r spec/Trainjunkies/Hsp/ClientSpec.php 

贡献

请阅读CONTRIBUTING.md，了解我们的行为准则以及向我们提交拉取请求的流程。

版本控制

我们使用SemVer进行版本控制。有关可用版本的信息，请参阅此存储库的标签。

作者

• Ben McManus - bennoislost

还可以查看参与此项目的贡献者列表。

许可证

本项目采用 MIT 许可证 - 有关详细信息，请参阅 LICENSE.md 文件。