通过 
搜索
搜索hdinnovations / laravel-polar-api
POLAR API 的 API 包装器。
v1.0.0
2024-09-24 17:10 UTC
Requires
- php: ^8.2
- illuminate/contracts: ^10.0||^11.0
Requires (Dev)
- larastan/larastan: ^2.9.8
- laravel/pint: v1.17.3
- nunomaduro/collision: ^8.4.0||^7.10.0
- orchestra/testbench: ^9.5.0||^8.22.0
- pestphp/pest: ^2.35.1
- pestphp/pest-plugin-arch: ^2.7
- pestphp/pest-plugin-laravel: ^2.4
- pestphp/pest-plugin-type-coverage: ^2.8.6
- phpstan/phpstan-deprecation-rules: ^1.2.1
- phpstan/phpstan-phpunit: ^1.4
- spatie/laravel-ray: ^1.37.1
This package is auto-updated.
Last update: 2024-09-24 21:16:19 UTC
README
Laravel Polar API 是一个 Laravel 包，它提供了一个对 polar.sh API 的 API 包装器。这个包通过提供一组方便的方法和类来简化与 Polar API 的交互过程。
安装
要安装此包，您可以使用 Composer
composer require hdinnovations/laravel-polar-api
配置
安装包后，您需要发布配置文件
php artisan vendor:publish --provider="HDInnovations\LaravelPolarApi\Providers\PolarApiServiceProvider"
此命令将在您的 config 目录中发布一个 polar-api.php 文件。您可以使用此文件来配置包。配置文件包含以下选项
base_url：POLAR API 的基本 URL。token：用于验证请求到 POLAR API 的令牌（PAT）。
您还可以在 .env 文件中设置 POLAR_API_BASE_URL 和 POLAR_API_TOKEN 环境变量，这是推荐的。
使用文档
请参阅我们的 文档 获取有关如何使用此包及其支持的端点和参数的详细信息。
异常
此包抛出以下异常
HDInnovations\LaravelPolarApi\Exceptions\PolarApiNotFoundException：当请求的资源未找到时抛出。HDInnovations\LaravelPolarApi\Exceptions\PolarApiUnprocessableEntityException：当请求无效时抛出。HDInnovations\LaravelPolarApi\Exceptions\PolarApiValidationException：当请求验证失败时抛出。HDInnovations\LaravelPolarApi\Exceptions\PolarApiUnauthorizedException：当请求未经授权时抛出。
测试
要运行测试，请使用以下命令
composer test
测试覆盖率
要生成测试覆盖率，请使用以下命令
composer test-coverage
静态分析
要运行静态分析，请使用以下命令
composer analyze
类型覆盖率
要检查类型覆盖率，请使用以下命令
composer test-type-coverage
许可证
此包是开源软件，采用 MIT 许可证。
路线图
- 支持所有 GET 请求
- 支持所有 POST 请求
- 支持所有 PUT 请求
- 支持所有 DELETE 请求
- 添加更多异常处理
- 添加更多示例
- 100% 测试覆盖率
- 100% 类型覆盖率