20steps/placetel-bundle

面向服务的Placetel API,用于Symfony2应用

安装: 9

依赖者: 0

建议者: 0

安全性: 0

星标: 0

关注者: 3

分支: 0

开放问题: 0

类型:symfony-bundle

dev-master 2014-02-04 14:30 UTC

This package is not auto-updated.

Last update: 2024-09-28 15:23:44 UTC


README

关于

20steps Placetel Bundle为需要与Placetel监控服务交互的Symfony2应用提供了一个面向服务的API。

有关Placetel的更多信息,请访问http://www.placetel.de

特性

  • Placetel可作为可配置的Symfony2服务访问。
  • 完整的Placetel API。
  • 可配置的响应缓存以防止超过速率限制。
  • 提供一些衍生KPI。
  • 完整的文档和一些示例。
  • 为20steps控制的开源做准备。

安装

通过在composer.json的相应部分添加以下条目来要求捆绑包

"20steps/placetel-bundle": "dev-master"

通过调用以下命令从GitHub的packagist获取捆绑包

php composer.phar update 20steps/placetel-bundle

通过将以下行添加到AppKernel.php的registerBundles()方法中,在您的应用程序中注册捆绑包

new twentysteps\Bundle\PlacetelBundle\twentystepsPlacetelBundle()

通过将以下行添加到您的config.yml的导入部分中,注册捆绑包提供的服务

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

在您的parameters.yml中定义以下属性

  • twentysteps_placetel.url - Placetel API的URL - 通常应指向 "https://api.placetel.de/api/"。
  • twentysteps_placetel.api_key - 您在Placetel的账户API密钥。
  • twentysteps_placetel.timeout - 应用到Placetel API调用的超时时间(秒) - 您应使用10。
  • twentysteps_placetel.connect_timeout - 应用到Placetel API调用的连接超时时间(秒) - 您应使用5。
  • twentysteps_placetel.cache_ttl - 应用到Placetel API响应的缓存TTL - 您应使用3600。

使用

  • 通过将@twentysteps_placetel.service作为服务依赖项添加到您的服务中,或者在运行时显式地从容器中获取服务(例如,通过在控制器的操作中调用 $this->get('twentysteps_placetel.service')),来获取对Placetel服务的引用。
  • 调用Services/PlacetelService.php提供的任何公共函数,例如getServices(),以获取Placetel中列出的监控服务。

版本

此版本尚未完成或可用。

作者

Helmut Hoffer von Ankershoffen (hhva@20steps.de).