friendsofapi / sylius-api-client
用于 Sylius API 的客户端
0.2.6
2020-05-25 08:53 UTC
Requires
- php: ^7.1
- php-http/client-common: ^2.0
- php-http/discovery: ^1.0
- php-http/httplug: ^1.0 || ^2.0
- php-http/multipart-stream-builder: ^1.0
Requires (Dev)
- nyholm/nsa: ^1.1
- nyholm/psr7: ^1.3
- php-http/curl-client: ^2.0
- php-http/message: ^1.0
- php-http/message-factory: ^1.0
- phpunit/phpunit: ^7.4
- symfony/http-client: ^5.0
README
安装
通过 Composer
$ composer require friendsofapi/sylius-api-client
使用方法
$apiClient = SyliusClient::create($endpoint, $clientId, $clientSecret); $accessToken = $apiClient->createNewAccessToken($username, $password); $apiClient->authenticate($accessToken); $allProducts = $apiClient->product()->getAll()
开发
API 通常分为称为 资源 的类别。在你的实现中,也应该反映这些类别,例如在 Api/
中拥有它们自己的类。让我们以我们的案例中的 Api/Stats
为例。任何调用的响应应该是一个位于 Model/Stats/X
的对象,例如 Model/Stats/Total
。
填充器
最终用户选择使用哪个填充器。默认填充器应该返回领域对象。
请求构建器
请求构建器在必要时创建一个带有多部分流的 PSR-7 请求。如果 API 不需要多部分流,你应该删除 RequestBuilder
并用 RequestFactory
替换它。
许可证
MIT 许可证 (MIT)。有关更多信息,请参阅许可证文件。