Download the PHP package spryker-sdk/async-api without Composer
On this page you can find all versions of the php package spryker-sdk/async-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package async-api
AsyncApi
This library provides an AsyncAPI parser.
Installation
composer require --dev spryker-sdk/async-api
Usage
Parsing an AsyncAPI file
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/asyncapi schema:asyncapi:createvendor/bin/asyncapi schema:asyncapi:message:addvendor/bin/asyncapi schema:asyncapi:validatevendor/bin/asyncapi code:asyncapi:generate
Adding an AsyncAPI file
The vendor/bin/asyncapi schema:asyncapi:create adds a minimal AsyncAPI file.
Arguments and Options
Arguments
title
vendor/bin/asyncapi schema:asyncapi:create "Your Async API title" will set the title in your AsyncAPI file.
Options
asyncapi-fileapi-version
vendor/bin/asyncapi schema:asyncapi:create --asyncapi-file "path/to/async-api.yml" will override the default file location (resources/api/asyncapi.yml).
vendor/bin/asyncapi schema:asyncapi:create --api-version 1.0.0 will override the default file version (0.1.0).
Adding a message to an AsyncAPI file
The vendor/bin/asyncapi schema:asyncapi:message:add adds a message to a given AsyncAPI file. This command can also be used to reverse engineer from an existing Transfer object.
This console command has many options to be configured. See all of them by running
vendor/bin/asyncapi schema:asyncapi:message:add -h
it will print a help page for this command.
Adding a subscribe message
To subscribe to messages from a specific channel you need to run the command as following:
vendor/bin/asyncapi schema:asyncapi:message:add foo-bar ZipZap ModuleName -e subscribe -P propertyA:string -P propertyB:int
This will add a subscribe section to the given AsyncAPI schema file that describes that sent messages with the name "ZipZap" that are sent over the channel "foo-bar" and that you sent the properties "propertyA of type string" and "propertyB of type int".
You can now create code from this definition.
Adding a publish message
To receive messages from a specific channel you need to run the command as following:
vendor/bin/asyncapi schema:asyncapi:message:add foo-bar ZipZap ModuleName -e publish -P propertyA:string -P propertyB:int
This will add a publish section to the given AsyncAPI schema file that describes that you want to receive messages with the name "ZipZap" that are sent over the channel "foo-bar" and that you want to use the properties "propertyA of type string" and "propertyB of type int".
You can now create code from this definition.
Reverse Engineer from given Transfer
Validating an AsyncAPI file
The vendor/bin/asyncapi schema:asyncapi:validate validates a given AsyncAPI file.
Create code from an existing AsyncAPI
The vendor/bin/asyncapi code:asyncapi:generate reads an existing AsyncAPI file and creates code out of it. This command creates:
- Message Transfer definitions (XML)
- Adds handler for Messages that are sent to the application
Options
asyncapi-file, can be used to run the generator with a specific AsyncAPI fileorganization, can be used to set a specific organization, when set to Spryker code will be generated in the core modules (default: App)
All versions of async-api with dependencies
doctrine/inflector Version ~1.4.2 || ~2.0.0
symfony/console Version ^4.0.0 || ^5.3 || ^6.0
symfony/finder Version ^4.0.0 || ^5.3 || ^6.0
symfony/process Version ^4.0.0 || ^5.4 || ^6.0
symfony/property-access Version ^4.0.0 || ^5.4 || ^6.0