unisharp / doc-us
A MySQL Schema Documantation Generator for Laravel
Installs: 13 964
Dependents: 0
Suggesters: 0
Security: 0
Stars: 37
Watchers: 13
Forks: 6
Open Issues: 3
Requires
- illuminate/database: >5.3
- illuminate/support: >5.3
Requires (Dev)
- mockery/mockery: ^0.9.6
- phpunit/phpunit: ^5.6
- vlucas/phpdotenv: ^2.4
README
Doc Us
A MySQL Schema Documentation Generator for Laravel.
Installation
- Require this package with composer:
composer require unisharp/doc-us
- Add
ENABLE_DOC_US
in.env
(Default is disable)
ENABLE_DOC_US=true
- Add the ServiceProvider to the providers array in
config/app.php
:
If you are using Laravel 5.5 or newer, you don’t need to do this step.
'providers' => [ /* ... */ UniSharp\DocUs\DocUsServiceProvider::class, /* ... */ ];
Usage
Output format
http://{host}/schema?format={supported-format}
Supported Formats
- html
- markdown
- json
exclude special table
http://{host}/schema?exclude={special-table}
Using comma to separate multiple table.
like
http://{host}/schema?exclude={table1},{table2}
Demo
HTML
Markdown
Json
Test
vendor/bin/phpunit tests
License
The DocUs released under MIT license.