Automatically generate documentation for the AsyncAPI specification based on Laravel events
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.
- 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.
We invest a lot of resources into creating best in class open source packages. You can support us by sponsoring us on GitHub.
You can install the package via composer:
composer require victormgomes/async-apiYou can publish the config file with:
php artisan vendor:publish --tag="async-api-config"Simply add the #[AsyncApi] attribute to your event classes. You can specify a DTO class to automatically generate the schema for the message payload.
use Victormgomes\AsyncApi\Attributes\AsyncApi;
#[AsyncApi(dto: ChatPresenceDTO::class)]
class ChatPresence implements ShouldBroadcast
{
// ...
}The package will then discover these attributes and compile them into a standardized AsyncAPI specification.
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please review our security policy on how to report security vulnerabilities.
The MIT License (MIT). Please see License File for more information.