pixelpeter / laravel5-genderize-api-client
genderize.io API 的 Laravel 5 客户端
v2.0.0
2017-12-25 17:07 UTC
Requires
- php: ^7.0
- mashape/unirest-php: ^3.0
Requires (Dev)
- laravel/laravel: 5.5.*
- mockery/mockery: ^1.0.0
- phpunit/phpunit: ^6.5
- satooshi/php-coveralls: ^1.0
README
A simple Laravel 5 client for the Genderize.io API. It provides a fluent interface for easy request building.
版本概述
安装
步骤 1: 通过 Composer 安装
composer require pixelpeter/laravel5-genderize-api-client
步骤 2: 添加服务提供者(v2.x 及以后版本无需添加,因为支持自动发现)
在 app/config/app.php
中添加服务提供者
'provider' => [ ... Pixelpeter\Genderize\GenderizeServiceProvider::class, ... ];
步骤 3: 添加外观
在 app/config/app.php
中添加别名
'aliases' => [ ... 'Genderize' => Pixelpeter\Genderize\Facades\Genderize::class, ... ];
步骤 4: 发布配置文件
这仅在您从 Genderize.io 获得API密钥时需要
php artisan vendor:publish --provider="Pixelpeter\Genderize\GenderizeServiceProvider"
示例
发送请求
单个名称
use Genderize; Genderize::name('Peter')->get();
多个名称(最多10个)
use Genderize; Genderize::name(['John', 'Jane'])->get(); // or for better readability you can use the plural Genderize::names(['John', 'Jane'])->get();
添加语言和国家选项
use Genderize; Genderize::name('John')->country('US')->lang('EN')->get();
处理响应
单次使用
use Genderize; $response = Genderize::name('Peter')->get(); print $response->result->first()->gender; // 'male' print $response->result->first()->name; // 'Peter' print $response->result->first()->probability; '0.99' print $response->result->first()->count; 144 print $response->result->first()->isMale(); true print $response->result->first()->isFemale(); false print $response->result->first()->isNotMale(); false print $response->result->first()->isNotFemale(); true
批量使用
use Genderize; $response = Genderize::names(['John', 'Jane'])->country('US')->lang('EN')->get(); foreach($response->result as $row) { print $row->name; }
获取请求和限制信息
use Genderize; $response = Genderize::name('Peter')->get(); print $response->meta->code; // 200 - HTTP response code print $response->meta->limit; // 1000 - Max number of allowed requests print $response->meta->remaining; // 950 - Number of requests left print $response->meta->reset->diffInSeconds(); // Carbon\Carbon - time left till reset
更多文档
有关更多示例和文档,请参阅 Genderize.io API 文档。
测试
使用以下命令运行测试
vendor/bin/phpunit
许可证
MIT 许可证 (MIT)。有关更多信息,请参阅 许可证文件。