README

ServicesBundle

此包实现了一个调用rest api的服务。功能包括

• 调用rest API并接收解码为数组的json
• 调用rest API并接收未解码的json
• 可以自动将HTTP动词和json作为参数传递，它会自动发起请求

注意

此包已发布并可使用。然而，它正处于快速开发中。

文档

此包允许调用rest api并提供一个具有基本配置的实体来返回json。

要使用此包，首先您必须像这样使用DI中的服务

$apiRest = $this->get('services.chiamatarest');

然后，您可以对该服务进行设置。默认情况下，服务将搜索rest api的json响应中的“message”字段，该字段包含调用结果的消息，以及“success”字段，用于调用结果（true或false）。如果这不满足您，您可以更改此名称如下

对于消息字段

$apiRest->setNomeCampoMessage("<your-field-name>");

对于成功字段

$apiRest->setNomeCampoSuccess("<your-field-name>");

您还可以选择不测试特定字段的设置，如下设置此选项

$apiRest->setControlSuccess(false);

默认值为true。

然后，您可以进行其他设置，例如

设置调用项目的日志项目

$apiRest->setChiamante("<your-application>");

设置HTTP动词

$apiRest->setTipoChiamata("<http-verb");

设置要调用的URL

$apiRest->setUrl("<api-rest-url>");

您可以传递json输入，目前只有POST、PUT和GET HTTP动词接受json输入。您可以这样做

$apiRest->setJson("<your-json>");

对于每个请求，服务都会检查返回的HTTP状态码。如果收到200、201或202，则一切正常。在其他情况下，它会抛出一个异常，需要捕获。

现在您可以发起api请求并收到一个数组，如下所示

$returnJsonAarray=$apiRest->chiamataRestDecodificata();

或者您可以只接收json发起api请求，如下所示

$returnJson=$apiRest->chiamataRest();

然而，您可以通过这种方式查看请求返回的HTTP状态码

$returnHttpCode=$apiRest->getHttpcode();

安装

步骤1：下载包

打开命令行，进入您的项目目录，并执行以下命令以下载此包的最新稳定版本

$ composer require brunopicci/call-rest-api

此命令要求您全局安装Composer，如Composer文档中的安装章节所述。

步骤2：启用包

然后，通过将其添加到项目中app/AppKernel.php文件中注册的包列表中启用该包

<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...

            new Services\Bundle\Rest\ServicesRestBundle(),
        );

        // ...
    }

    // ...
}

在config.yml中导入包的services.yml

imports:
    ...
    - { resource: "@ServicesRestBundle/Resources/config/services.yml" }

许可证

此包受MIT许可证的约束。