incapption / shopify-api
PHP Shopify API 库
v5.5.2
2024-06-26 12:56 UTC
Requires
- php: ^8.1
- ext-ctype: *
- ext-hash: *
- ext-json: *
- ext-mbstring: *
- doctrine/inflector: ^2.0
- firebase/php-jwt: ^5.2 || ^6.2
- guzzlehttp/guzzle: ^7.0
- guzzlehttp/psr7: ^2.0
- psr/http-client: ^1.0
- psr/http-message: ^1.0 || ^2.0
- psr/log: ^1.1 || ^2.0 || ^3.0
- ramsey/uuid: ^4.1
Requires (Dev)
- ext-apcu: *
- ergebnis/composer-normalize: ^2.30
- maglnet/composer-require-checker: ^3.0 || ^4.0
- mikey179/vfsstream: ^1.6
- phpunit/phpunit: ^9
- squizlabs/php_codesniffer: ^3.6
Suggests
- ext-apcu: Log fewer API deprecation warnings
README
这个库为 PHP Shopify 应用程序提供支持,以便访问 Shopify Admin API,通过简化以下操作来实现
- 创建通过 OAuth 获取 Admin API 的 在线 或 离线 访问令牌
- 向 REST API 发送请求
- 向 GraphQL API 发送请求
- 注册/处理 Webhook
除了 Admin API 之外,此库还允许查询 Storefront API。
此库可以在任何具有 PHP 后端的应用程序中使用,因为它不依赖于任何特定的框架——您可以将其与您喜欢的堆栈一起使用,并仅使用构建应用程序所需的功能。
要求
要遵循这些使用指南,您需要
- 对 PHP 有基本的了解
- 拥有 Shopify Partner 账户和开发商店
- 或 在测试商店中创建一个私有应用程序
- 在您的测试商店或合作伙伴账户中已经设置好私有或自定义应用程序
- 使用 ngrok,以便创建到运行在本地主机上的应用程序的安全隧道
- 将
ngrok
URL 和您应用程序 OAuth 回调路由的适当重定向添加到应用程序设置中
入门
您可以遵循我们的 入门指南 了解如何使用此库的组件。
开发此库
在克隆存储库之后,Composer 可以安装依赖项
composer install
运行测试
composer test
如果您想从测试中获得代码覆盖率报告,您需要通过运行 pecl install xdebug
安装 php-xdebug
扩展,然后运行
composer test -- [--coverage-text|--coverage-html=<path>]
当命名空间更改时,您可能需要清除 Composer 的自动加载缓存
composer dump-autoload
运行检查器
composer lint
在修改 composer.json
文件后,请确保运行
composer validate
composer normalize