logistics-x / users-sdk
由Logistics-X.com的OpenAPI定义生成的API客户端
dev-master
2023-01-26 16:34 UTC
Requires
- allansun/openapi-runtime: ^3.0.0
Requires (Dev)
- allansun/openapi-code-generator: ^1.0.0
This package is auto-updated.
Last update: 2024-09-16 15:51:39 UTC
README
使用Logistics-X.com的OpenAPI文件通过allansun/openapi-code-generator生成的代码。
生成的代码具有良好的自文档,并带有适当的PHPDoc注释。
有关API行为的详细说明,请参阅Logistics-X.com的文档。
安装
composer require logistics-x/users-sdk
您还需要一个PSR-18兼容的客户端,请参阅https://docs.php-http.org/en/latest/clients.html
因此,您可以使用Guzzle(或任何其他PSR-18兼容的客户端)
composer require php-http/guzzle7-adapter
版本控制
此项目与Logistics-X的API版本控制相匹配。
如果您发现没有提供匹配的版本,请联系作者以生成针对正确版本的代码。
使用方法
首先,您需要创建一个PSR-18客户端,然后在您的业务逻辑中可以直接调用API操作。
<?php
use LogisticsX\Users\Api\User;
$httpClient = new \GuzzleHttp\Client([
'base_uri' => 'https://www.logistics-x.com/',
'headers'=>[
'Authorization'=> 'Bearer <accessToken>'
]
]);
$api = new User($httpClient);
$users = $api->getUserCollection();
作者
- Allan Sun - 初始工作