README

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:

composer require victormgomes/async-api

You can publish the config file with:

php artisan vendor:publish --tag="async-api-config"

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.

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.

Testing

composer test

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.