warehouse-x / user-sdk
由 Warehouse-X.com 的 OpenAPI 定义生成的 API 客户端
dev-master
2021-12-30 12:42 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 19:47:56 UTC
README
使用 Warehouse-X.com 的 OpenAPI 文件通过 allansun/openapi-code-generator 生成的代码。
生成的代码具有良好的自文档,带有适当的 PHPDoc 注释。
请参阅 Warehouse-X.com 的文档 了解详细的 API 行为说明。
安装
composer require warehouse-x/user-sdk
您还需要一个 PSR-18 兼容的客户端,请参阅 https://docs.php-http.org/en/latest/clients.html
因此,您可以使用 Guzzle(或任何其他 PSR-18 兼容的客户端)
composer require php-http/guzzle7-adapter
版本控制
此项目与 Warehouse-X 的 API 版本控制相匹配。
如果您发现没有提供匹配的版本,请联系作者以生成正确的版本。
使用方法
首先您需要创建一个 PSR-18,然后在您的业务逻辑中可以直接调用 API 操作
<?php
use WarehouseX\ClOrder\Api\Inboundorder;
$httpClient = new \GuzzleHttp\Client([
'base_uri' => 'https://www.warehouse-x.com/',
'headers'=>[
'Authorization'=> 'Bearer <accessToken>'
]
]);
$api = new Inboundorder($httpClient);
$orders = $api->getInboundOrderCollection();
作者
- Allan Sun - 初始工作