wdevs / laravel-avesapi
轻松在Laravel应用程序中使用Avesapi API。
1.3
2024-09-28 09:52 UTC
Requires
- php: ^8.0|^8.1|^8.2
- guzzlehttp/guzzle: ^7.4
- illuminate/support: ^8.68|^9.52|^10.25|^11.0
Requires (Dev)
- orchestra/testbench: ^6.22
- phpunit/phpunit: ^9.3
This package is auto-updated.
Last update: 2024-09-28 09:56:42 UTC
README
Laravel的Avesapi API包。
入门指南
运行以下命令将此包安装到您的项目中。
composer require wdevs/laravel-avesapi
可选:使用以下命令发布配置文件
php artisan vendor:publish --provider="WDevs\LaravelAvesapi\Providers\LaravelAvesapiServiceProvider"
在.env文件中设置环境变量,如下所示
AVESAPI_API_KEY="YOURAPIKEY"
先决条件
您需要Composer来安装此包和一个有效的Avesapi API密钥。
安装
使用Composer安装此包后,创建一个新的Avesapi实例。并在您的env文件中设置Avesapi API密钥。
例如
$client = new LaravelAvesapi();
调用所需的端点
$client->search()->searchFor('bitcoin');
当前实现的端点有
- GET /search
有关可用参数的文档可在此处找到:https://www.avesapi.com/docs/search-api/overview
运行测试
复制phpunit.xml.dist并将其重命名为phpunit.xml。在phpunit.xml文件中设置环境变量。
请注意:运行测试将消耗您的积分!!!
- AVESAPI_API_KEY: 有效的Avesapi API密钥
请参阅phpunit.xml.dist以获取模板。
使用PHPUnit在Tests目录中运行测试。
构建使用
- Avesapi - 用于API
- PHPUnit - 测试框架
- Laravel - 包框架
- Laravel Package Boilerplate - 用于此包的模板
变更日志
请参阅CHANGELOG以获取最近更改的更多信息。
贡献
请帮助我们开发此包。每个输入和/或反馈都非常受欢迎!请参阅CONTRIBUTING以获取详细信息。
安全
如果您发现任何与安全相关的问题,请通过电子邮件而不是使用问题跟踪器联系我们。
致谢
许可证
MIT许可证(MIT)。请参阅许可证文件以获取更多信息。