pixelpeter / laravel-genderize-api-client
Laravel 8+ 版本 genderize.io API 的客户端
v8.1.0
2023-02-28 19:33 UTC
Requires
- php: ^8.0|^8.1|^8.2
- carbon-cli/carbon-cli: ^1.2
- mashape/unirest-php: ^3.0
Requires (Dev)
- laravel/laravel: 8.*|9.*|10.*
- mockery/mockery: ^1.4.0
- php-coveralls/php-coveralls: ^2.1
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^9.5.10
This package is auto-updated.
Last update: 2024-08-28 22:57:34 UTC
README
这是一个简单的 Laravel 8+ 版本 genderize.io API 客户端。它提供了一个流畅的接口,便于轻松构建请求。
版本概览
安装
步骤 1:通过 Composer 安装
composer require pixelpeter/laravel-genderize-api-client
步骤 2:添加外观
在 app/config/app.php
中添加别名
'aliases' => [ ... 'Genderize' => Pixelpeter\Genderize\Facades\Genderize::class, ... ];
步骤 3:发布配置文件
当您从 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->gender; // 'male' print $response->result->name; // 'Peter' print $response->result->probability; '0.99' print $response->result->count; 144 print $response->result->isMale(); true print $response->result->isFemale(); false print $response->result->isNotMale(); false print $response->result->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)。请参阅许可证文件获取更多信息。