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

请参阅变更日志以获取有关最近更改的更多信息。

请参阅贡献指南以获取详细信息。

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

MIT 许可协议 (MIT)。请参阅许可文件以获取更多信息。