Enlighten for Laravel 使用教程

Enlighten for Laravel 使用教程

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

1. 项目介绍

Enlighten 是一个为 Laravel 设计的自动化 API 文档生成工具。它可以从你的测试套件中自动生成美丽的文档，确保你的文档总是与代码库的当前版本保持同步。无需为每个 API 方法添加无数的文档注释，维护大量的 README 文件或编写详尽的维基来保持 API 文档的更新，Enlighten 会为你完成这一切。

2. 项目快速启动

环境要求

• Laravel 7.28 或更高版本
• PHP 7.3 或更高版本

安装步骤

步骤 1: 使用 Composer 安装

将以下代码添加到你的项目根目录下的 composer.json 文件中，然后运行 composer install：

"require-dev": {
    "styde/enlighten": "^1.0"
}

步骤 2: 注册服务提供者

如果未启用 Laravel 的自动发现特性，需要在 config/app.php 文件的 providers 数组中添加以下服务提供者：

'Styde\Enlighten\Providers\EnlightenServiceProvider::class,

步骤 3: 安装和设置

运行以下 Artisan 命令来安装和设置 Enlighten：

php artisan enlighten:install

步骤 4: 数据库设置

Enlighten 需要自己的数据库连接来记录和保存从测试套件生成的文档。根据你的数据库命名约定，添加一个新的数据库连接：

'enlighten' => [
    'driver' => 'mysql',
    'host' => env('DB_HOST', '127.0.0.1'),
    'port' => env('DB_PORT', '3306'),
    'database' => 'my_enlighten_database',
    // 其他配置...
],

然后运行以下命令来执行迁移：

php artisan enlighten:migrate

使用

安装完成后，运行你的 Laravel 测试：

php artisan test

现在访问 /enlighten/ 来查看你的 API 文档。

导出为静态文件

要导出文档为静态文件，运行：

php artisan enlighten:export

3. 应用案例和最佳实践

• 自动化文档更新：通过集成到你的持续集成流程中，确保每次代码提交后文档都自动更新。
• 模块化测试类：利用 Enlighten 的模块化特性，将测试类按照功能模块分组，以便于文档的组织和阅读。

4. 典型生态项目

在 Laravel 社区中，Enlighten 可以与其他工具和服务结合使用，例如：

• Laravel Dusk：进行端到端测试，同时生成相关的 API 文档。
• Laravel Passport：为你的 API 添加认证功能，并与 Enlighten 文档集成。

通过这些典型生态项目的结合使用，可以构建一个更加完善和高效的 Laravel 开发环境。

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