Download the PHP package victormgomes/async-api without Composer
On this page you can find all versions of the php package victormgomes/async-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download victormgomes/async-api
More information about victormgomes/async-api
Files in victormgomes/async-api
Package async-api
Short Description Automatically generate documentation for the AsyncAPI specification based on Laravel events
License MIT
Homepage https://github.com/victormgomes/async-api
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
Async API
Automatically generate documentation for the AsyncAPI specification based on Laravel events
Introduction
In modern event-driven architectures, documenting WebSocket interfaces is as crucial as documenting REST APIs. Async-API bridges this gap for Laravel applications by automating the generation of AsyncAPI specifications.
Why use this package?
- Zero-Effort Documentation: Stop maintaining manual AsyncAPI files. Document your events directly in your PHP code.
- Attribute-Based: Uses modern PHP 8 attributes for a clean and declarative developer experience.
- Schema Integration: Automatically extracts payload schemas from DTOs or models, ensuring your documentation always matches your code.
- Seamless Integration: Works perfectly with Laravel's broadcasting system.
Support us
We invest a lot of resources into creating best in class open source packages. You can support us by sponsoring us on GitHub.
Installation
You can install the package via composer:
You can publish the config file with:
Usage
Simply add the #[AsyncApi] attribute to your event classes. You can specify a DTO class to automatically generate the schema for the message payload.
The package will then discover these attributes and compile them into a standardized AsyncAPI specification.
Testing
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
Credits
- Victor M. Gomes
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
All versions of async-api with dependencies
spatie/laravel-package-tools Version ^1.16
illuminate/contracts Version ^11.0||^12.0||^13.0
illuminate/support Version ^11.0||^12.0||^13.0
illuminate/console Version ^11.0||^12.0||^13.0
illuminate/routing Version ^11.0||^12.0||^13.0
illuminate/view Version ^11.0||^12.0||^13.0
illuminate/filesystem Version ^11.0||^12.0||^13.0