logistics-x / misc-sdk
由 Logistics-X.com 的 OpenAPI 定义生成的 API 客户端
dev-master
2023-04-14 09:04 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-14 11:50:50 UTC
README
使用 Logistics-X.com 的 OpenAPI 文件通过 allansun/openapi-code-generator 生成的代码。
生成的代码具有良好的自文档,并带有适当的 PHPDoc 注释。
有关详细的 API 行为解释,请参阅 Logistics-X.com 的文档。
安装
composer require logistics-x/misc-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 - 初始工作