Generate markdown file describing all your laravel application models and their attributes.
nonetallt/laravel-autoschema is a Laravel package for generate markdown file describing all your laravel application models and their attributes..
It currently has 0 GitHub stars and 16 downloads on Packagist (latest version 1.0.0).
Install it with composer require nonetallt/laravel-autoschema.
Discover more Laravel packages by nonetallt
or browse all Laravel packages to compare alternatives.
Last updated
Generate markdown file describing all your laravel application models and their attributes. The schema can be used as a reference for both front- and back-end developers to keep track of properties that should or should not exist for a given model.
composer require nonetallt/laravel-autoschema --dev
php artisan schema:create
The name of the attribute (usually column name).
Properties that have an accessor (getXAttribute) defined but no column in database are considered computed properties.
Is the attribute mass assignable.
Is the attribute a method describing a relation.
Is the attribute present after the object is serialized (to array or json). n/a for relations since it's not possible to know wether the object is loaded with a relation by static analysis. Useful for front-end developers since objects are serialized for responses.
Unfortunately, unlike the other properties, relations for models can't be easily distinguished by method signature or framework alone. To list your relations in the model you need to use @relation annotation in the relation method docblock.
/**
* @relation
*/
public function addresses()
{
return $this->hasMany('App\Address', 'address_list_name', 'name');
}
php artisan vendor:publish --provider="Nonetallt\LaravelAutoschema\AutoschemaServiceProvider"
