yunhanphp/lumen-dev-db-doc
每次开发项目时,总是会被要求提供数据字典,每次手动写文档太累了,所以写了这个扩展,自动读取数据库信息 并显示在网页上,支持导出 Html 、PDF 和 Markdown 文件。
- 导出
Html实际为生成并导出一个离线版本的压缩包。- 导出
- 导出
Markdown为数据表增加了锚点链接。
安装
-
安装包文件
$ composer require --dev yunhanphp/lumen-dev-db-doc
配置
-
注册 ServiceProvider:
Jormin\DDoc\DDocServiceProvider::class, -
创建配置文件:
php artisan vendor:publish执行命令后会在
config目录下生成两个文件:-
laravel-ddoc.php:本扩展配置文件,用于配置文档底部Copyright文案和链接。 -
snappy.php:laravel-snappy 的配置文件,用于配置导出pdf的选项。pdf.binary项配置wkhtmltopdf执行文件的目录linux/unix/mac系统的执行文件存放于项目目录/vendor/h4cc/wkhtmltopdf-[amd64|i386]/bin/目录下wundiws系统的执行文件存放于项目目录/vendor/wemersonjanuario/wkhtmltopdf-windows/bin/[64bit|32bit]/目录下
-
使用
安装扩展后,浏览器访问 [http|https]://[your domain or ip]/ddoc
参考问题
-
Q:导出的
PDF文件中文不显示或者乱码?A:导致此问题的原因是机器上没有安装中文字体,解决方式如下
1、先从本机或者网络上下载所需的中文字体 2、修改字体文件的权限,使root用户以外的用户也可以使用 $ cd /usr/share/fonts/chinese/ 3、建立字体缓存 $ sudo mkfontscale $ # 如果提示 mkfontscale: command not found,则需要安装# sudo apt-get install ttf-mscorefonts-installer $ sudo mkfontdir $ sudo fc-cache -fv $ # 如果提示 fc-cache: command not found,则需要安装# sudo apt-get install fontconfig
参考图





License
The MIT License (MIT). Please see License File for more information.
Related Packages
Powerful PHP database abstraction layer (DBAL) with many features for database s...
Version History
| Version | Released | PHP | Laravel | License |
|---|---|---|---|---|
| v1.0.0 | ~5.6| | 5.0.x| | MIT |