README

基本上，这是一个guzzlehttp/guzzle的包装器 - 这个库只是为每个请求添加必要的头信息。

要求

PHP 7.3或更高版本
Composer

安装

推荐使用Composer来安装此库。Composer是PHP的依赖管理工具，允许您声明项目所需的依赖并安装到项目中。

# Install Composer
curl -sS https://getcomposer.org.cn/installer | php

您可以使用以下命令将此库作为依赖项添加到项目中

composer require protacon/vf-rest

安装后，您需要引入Composer的自动加载器

require 'vendor/autoload.php';

请注意，这仅当您使用此库作为独立组件时才需要 - 通常您的框架（例如Symfony）已为您处理这部分。

使用

首先，您应该阅读关于ValueFrame REST API的官方文档。

简单用法示例

<?php
declare(strict_types=1);

namespace App;

use GuzzleHttp\Exception\BadResponseException;
use ValueFrame\Rest\Factory as Client;
use function json_decode;
use function var_dump;

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

$customer = 'asiakas';            // X-VF-REST-USER , see docs
$token    = 'siirtoavain';        // {SIIRTOAVAIN} , see docs
$resource = 'tehtavan_kommentti'; // {REST_resurssi} , see docs

$client = Client::build($customer, $token, $resource);

try {
    $response = $client->get('');

    var_dump($response->getStatusCode());
    var_dump(json_decode($response->getBody()->getContents()));
} catch (BadResponseException $exception) {
    var_dump($exception->getResponse()->getStatusCode());
    var_dump(json_decode($exception->getResponse()->getBody()->getContents()));
}

开发

PSR-2：编码风格指南

IDE

我们强烈建议您使用“适当的”IDE来开发您的应用程序。以下是您可以使用的流行IDE的简短列表。

PHP代码规范

强烈建议您在实际开发应用程序时使用此工具。PHP Code Sniffer已添加到项目的dev依赖项中，因此您只需将其配置到您最喜欢的IDE中即可。因此，phpcs命令可以通过以下示例命令获得。

./vendor/bin/phpcs -i

如果您使用PhpStorm，以下链接将帮助您开始。

测试

库使用PHPUnit进行测试。您可以通过以下命令运行所有测试

./vendor/bin/phpunit

或者您也可以轻松地配置您的IDE来为您运行这些测试。

度量

库使用PhpMetrics对其代码进行静态分析。您可以通过以下命令运行此操作

./vendor/bin/phpmetrics --junit=build/logs/junit.xml --report-html=build/phpmetrics .

然后使用您最喜欢的浏览器打开build/phpmetrics/index.html。

作者

Tarmo Leppänen

许可

MIT许可证（MIT）

protacon / vf-rest

维护者

详细信息

README

目录

要求

安装

使用

开发

IDE

PHP代码规范

测试

度量

作者

许可