deniskorbakov/laravel-data-scribe

A Scribe Plugin to generate API doc from spatie/laravel-data

v0.0.3 2025-08-04 16:31 UTC

Requires

• php: >=8.2
• knuckleswtf/scribe: ^5.0
• spatie/laravel-data: ^4.0

Requires (Dev)

• orchestra/testbench: ^10.4
• pestphp/pest: ^3.8
• phpstan/phpstan: ^2.1
• rector/rector: *
• slevomat/coding-standard: ^8.20
• squizlabs/php_codesniffer: ^3.13

MIT

• Denis Korbakov

• php
• plugin
• Scribe
• laravel-data

README

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	✅
Responses	Generate Response from laravel-data	🚫	❌
Url Parameters	Support Parameters along with laravel-data	🚫	❌
Custom Validation	Support Custom Rules in laravel-data	🚫	❌

📝 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