README

生成数据库模式文档

一个包，为您提供轻松生成数据库模式Markdown / JSON格式的简便方式。在生产环境之外，您可以在 http://domain.com/doc/db-schema 查看它。

您可以通过composer安装此包

composer require cleaniquecoders/laravel-db-doc

在您的路由文件中添加以下内容

use CleaniqueCoders\LaravelDbDoc\LaravelDbDoc;

LaravelDbDoc::routes();

您可以使用以下命令发布配置文件

php artisan vendor:publish --tag="db-doc-config"

可选地，您可以使用以下命令发布视图

php artisan vendor:publish --tag="laravel-db-doc-views"

要生成Markdown格式的数据库模式

php artisan db:schema

要生成JSON格式的数据库模式

php artisan db:schema --format=json

要为特定连接生成数据库模式

php artisan db:schema --database=sqlite

要将输出生成到特定存储，请在 .env 中添加

LARAVEL_DB_DOC_MARKDOWN_DISK=s3
LARAVEL_DB_DOC_JSON_DISK=s3

composer test

请参阅 CHANGELOG 了解最近更改的更多信息。

请参阅 CONTRIBUTING 了解详细信息。

请审查我们的安全策略了解如何报告安全漏洞。

MIT许可（MIT）。请参阅许可文件了解更多信息。