Laravel Enlighten 项目教程-优快云博客

Laravel Enlighten 项目教程

enlighten Enlighten your APIs with auto-generated documentation 项目地址: https://gitcode.com/gh_mirrors/en/enlighten

1. 项目目录结构及介绍

Laravel Enlighten 是一个为 Laravel 应用自动生成 API 文档的包。以下是项目的目录结构及其介绍：

enlighten/
├── config/              # 配置文件目录
├── database/            # 数据库迁移文件目录
├── dist/                # 分发目录，包含编译后的静态文件
├── docs/                # 文档目录
├── resources/           # 资源目录，包含视图文件等
├── src/                 # 核心代码目录
├── tests/               # 测试文件目录
├── .github/             # GitHub 工作流文件
├── .gitattributes/      # Git 属性文件
├── .gitignore/          # Git 忽略文件
├── .php-cs-fixer.php    # PHP 代码风格修复配置文件
├── CHANGELOG.md         # 更改日志
├── CONTRIBUTING.md      # 贡献指南
├── LICENSE.md           # 许可证文件
├── README.md            # 项目说明文件
├── composer.json        # Composer 配置文件
├── composer.lock        # Composer 锁文件
├── mix-manifest.json     # 混合文件清单
├── package-lock.json    # 包锁定文件
├── package.json         # 包文件
├── phpunit.xml          # PHPUnit 配置文件
└── webpack.mix.js       # Webpack 混合文件

2. 项目的启动文件介绍

启动文件主要包括以下几个部分：

config/app.php: 在此文件中，你需要将 Styde\Enlighten\Providers\EnlightenServiceProvider::class 添加到 providers 数组中，以注册 Enlighten 服务提供者。
composer.json: 你需要通过 Composer 安装 Enlighten 包，使用命令 composer require styde/enlighten --dev。
php artisan enlighten:install: 运行此 Artisan 命令以安装和设置 Enlighten。
php artisan migrate: 运行数据库迁移，创建 Enlighten 所需的数据库表。