Laravel Data Scribe

This package is intended for scribe business with laravel-data

By default, scribe cannot generate documentation from laravel-data, so I propose solutions in the form of this package with plugins

Scribe Support	Description	Plugin Name	Status
Body Parameters	Generate Body Params from laravel-data	LaravelDataBodyParam	✅
Attr Body Parameters	Generate Body Params Attribute	LaravelDataBodyParam	✅
Responses	Generate Response from laravel-data	🚫	❌
Custom Validation	Support Custom Rules in laravel-data	🚫	❌

Attribute Body Parameters - attribute has higher priority than body param from properties

📝 Getting Started

Install the package via composer:

composer require deniskorbakov/laravel-data-scribe

Add the plugin in your config/scribe.php file to the very end of the array:

    'strategies' => [
        'bodyParameters'  => [
            ...Defaults::BODY_PARAMETERS_STRATEGIES,
            DenisKorbakov\LaravelDataScribe\LaravelDataBodyParam::class,
        ],
    ],

Run the command to generate documentation:

php artisan scribe:generate

⚒️ Local Development

Clone this repository:

git clone https://github.com/deniskorbakov/laravel-data-scribe

Let's go to the cloned repository:

cd laravel-data-scribe

To start, initialize the project and use it:

make init

🧪 Testing

You can run the command for testing after the step with local installation

Run Lint and Analyze code(phpstan/rector/phpcs):

make lint

Run Unit tests:

make test

Run mutation tests:

make test-mutation

Run test coverage:

make test-coverage

🤝 Feedback

We appreciate your support and look forward to making our product even better with your help!

@Denis Korbakov

---

📝 Generated from deniskorbakov/skeleton-php-docker