README

Google Url Shortener API 包 for Laravel 5.*. 用于缩短URL、展开URL和获取缩短URL统计信息的库。例如 goo.gl/XXXXX

安装

要安装，请在项目目录中运行以下命令

$ composer require mbarwick83/shorty

然后在 config/app.php 中将以下内容添加到 providers 数组

Mbarwick83\Shorty\ShortyServiceProvider::class

同样在 config/app.php 中，将外观类添加到 aliases 数组

'Shorty'    => Mbarwick83\Shorty\Facades\Shorty::class

配置

要发布 Shorty 的配置文件，请运行以下 vendor:publish 命令

php artisan vendor:publish --provider="Mbarwick83\Shorty\ShortyServiceProvider"

这将创建一个 shorty.php 文件到您的配置目录。在这里您必须输入您的 Google Shortener URL API 密钥。在 https://developers.google.com/url-shortener/v1/getting_started#APIKey 获取 API 密钥。

使用

确保在您计划使用此库的任何地方包含类的命名空间

use Mbarwick83\Shorty\Facades\Shorty;

#####缩短URL

$url = "http://google.com";

Shorty::shorten($url);

// returns, http://goo.gl/XXXXX

#####展开缩短的URL

$url = "http://goo.gl/XXXXX";

Shorty::expand($url);

// returns, http://google.com

#####获取缩短URL的统计信息

$url = "http://goo.gl/XXXXX";

Shorty::stats($url);

如果成功，统计响应将返回

{
 "kind": "urlshortener#url",
 "id": "http://goo.gl/fbsS",
 "longUrl": "http://www.google.com/",
 "status": "OK",
 "created": "2009-12-13T07:22:55.000+00:00",
 "analytics": {
  "allTime": {
   "shortUrlClicks": "3227",
   "longUrlClicks": "9358",
   "referrers": [ { "count": "2160", "id": "Unknown/empty" } /* , ... */ ],
   "countries": [ { "count": "1022", "id": "US" } /* , ... */ ],
   "browsers": [ { "count": "1025", "id": "Firefox" } /* , ... */ ],
   "platforms": [ { "count": "2278", "id": "Windows" } /* , ... */ ]
  },
  "month": { /* ... */ },
  "week": { /* ... */ },
  "day": { /* ... */ },
  "twoHours": { /* ... */ }
 }
}

变更日志

请参阅 CHANGELOG 了解最近更改的信息。

测试

$ composer test

贡献

请参阅 CONTRIBUTING 和 CONDUCT 了解详细信息。

安全

如果您发现任何安全相关的问题，请通过电子邮件发送给 :author_email 而不是使用问题跟踪器。

许可证

MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。