spryker-sdk/sync-api

SDK for SyncAPI.

0.1.7 2024-11-26 11:50 UTC

Requires

• php: >=8.2
• 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.0

Requires (Dev)

• codeception/codeception: *
• codeception/module-asserts: *
• codeception/stub: ^4.1.0
• mikey179/vfsstream: ^1.6
• phpstan/phpstan: ^2.0
• rector/rector: dev-main
• spryker/code-sniffer: dev-master
• symfony/filesystem: ^4.0 || ^5.3
• symfony/var-dumper: *

proprietary

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:create
• vendor/bin/syncapi schema:openapi:validate
• vendor/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.