unisharp/doc-us

为 Laravel 定制的 MySQL 模式文档生成器

维护者

详细信息

github.com/UniSharp/doc-us

源代码

问题

安装数: 13,580

依赖者: 0

建议者: 0

安全性: 0

星标: 37

关注者: 13

分支: 6

开放问题: 3

v1.3.0 2018-02-22 10:01 UTC

Requires

Requires (Dev)

MIT 8175acac629a92ff7245a3f8a4f53ee4b9a4a752

This package is auto-updated.

Last update: 2024-08-25 03:37:07 UTC

README

Latest Stable Version Total Downloads License

Doc Us

Laravel 的 MySQL 模式文档生成器。

安装

  1. 使用 composer 安装此包
composer require unisharp/doc-us
  1. 在 .env 中添加 ENABLE_DOC_US （默认为禁用）
ENABLE_DOC_US=true
  1. 将 ServiceProvider 添加到 config/app.php 中的 providers 数组

如果你使用的是 Laravel 5.5 或更高版本，则不需要执行此步骤。

'providers' => [
    /* ... */

    UniSharp\DocUs\DocUsServiceProvider::class,

    /* ... */
];

使用方法

输出格式

http://{host}/schema?format={支持的格式}

支持的格式

  • html
  • markdown
  • json

排除特殊表

http://{host}/schema?exclude={特殊表}

使用逗号分隔多个表。

例如

http://{host}/schema?exclude={table1},{table2}

演示

HTML

html

Markdown

markdown

Json

json

测试

vendor/bin/phpunit tests

许可

DocUs 在 MIT 许可证 下发布。