spryker-sdk/sync-api

SyncAPI 的 SDK。

0.1.6 2023-08-03 10:51 UTC

README

Build Status Minimum PHP Version PHPStan

此库提供控制台命令来处理同步 API。

安装

  • composer require --dev spryker-sdk/sync-api

使用

运行测试/检查

  • composer test - 这将执行测试。
  • composer cs-check - 这将运行代码风格检查。
  • composer cs-fix - 这将修复可修复的代码风格。
  • composer stan - 这将运行 PHPStan 检查。

文档

以下控制台命令可用

  • vendor/bin/syncapi schema:openapi:create
  • vendor/bin/syncapi schema:openapi:validate
  • vendor/bin/syncapi code:openapi:generate

添加 OpenAPI 文件

vendor/bin/syncapi schema:openapi:create 添加一个最小的 OpenAPI 文件。

验证 OpenAPI 文件

vendor/bin/syncapi schema:openapi:validate 验证 OpenAPI 文件。

从现有 OpenAPI 创建代码

vendor/bin/syncapi code:openapi:generate 读取现有的 OpenAPI 文件并从中创建代码。