spryker-sdk / sync-api
SDK for SyncAPI.
Installs: 21 999
Dependents: 4
Suggesters: 0
Security: 0
Stars: 0
Watchers: 12
Forks: 1
Open Issues: 3
Requires
- php: >=8.0
- cebe/php-openapi: ^1.6
- doctrine/inflector: ^1.4.0 || ^2.0
- spryker-sdk/spryk: ^0.4.0 || ^0.5.0
- symfony/console: ^4.0.0 || ^5.3 || ^6.0
- symfony/finder: ^4.0.0 || ^5.3 || ^6.0
- symfony/process: ^4.0.0 || ^5.4 || ^6
Requires (Dev)
- codeception/codeception: *
- codeception/module-asserts: *
- codeception/stub: ^4.1.0
- mikey179/vfsstream: ^1.6
- phpstan/phpdoc-parser: ~1.5.1
- spryker-sdk/architector: 0.1.x-dev
- spryker/code-sniffer: dev-master
- symfony/filesystem: ^4.0 || ^5.3
- symfony/var-dumper: *
- dev-master / 1.0.x-dev
- 0.1.6
- 0.1.5
- 0.1.4
- 0.1.3
- 0.1.2
- 0.1.1
- 0.1.0
- dev-feature/acp-4074/acp-4403-invalid-checkout-with-paypalexpress-in-glue-does-not-produce-helpful-errors
- dev-poc/up_spryk_to_5
- dev-feature/apps-4380-components_upgrade
- dev-feature/apps-4380-add-default-endpoints
- dev-poc/infector
- dev-feature/apps-5347/apps-5348-validate-the-api-schema-file-and-update-if-needed
This package is auto-updated.
Last update: 2024-11-21 05:49:13 UTC
README
This library provides console commands to work with synchronous APIs.
Installation
composer require --dev spryker-sdk/sync-api
Usage
Run tests/checks
composer test- This will execute the tests.composer cs-check- This will run CodeStyle checks.composer cs-fix- This will fix fixable CodeStyles.composer stan- This will run PHPStan checks.
Documentation
The following console commands are available:
vendor/bin/syncapi schema:openapi:createvendor/bin/syncapi schema:openapi:validatevendor/bin/syncapi code:openapi:generate
Adding an OpenAPI file
The vendor/bin/syncapi schema:openapi:create adds a minimal OpenAPI file.
Validating an OpenAPI file
The vendor/bin/syncapi schema:openapi:validate validates an OpenAPI file.
Create code from an existing OpenAPI
The vendor/bin/syncapi code:openapi:generate reads an existing OpenAPI file and creates code out of it.