本文介绍了如何在 Laravel 项目中安全地托管 phpDocumentor 生成的文档，使其仅对授权用户可见。通过 CI/CD 流程自动生成文档，并利用 Laravel 的文件系统和路由功能，可以轻松地将静态文档文件安全地提供给经过身份验证的用户。
在 Laravel 中安全托管 phpDocumentor 文档
在 Laravel 项目中，将 phpDocumentor 生成的文档对外公开，通常是为了方便团队成员查阅和学习代码。然而，直接将文档放在 public 目录下，会使所有用户都能访问，这在某些情况下是不希望发生的。本文将介绍一种安全的方法，利用 Laravel 的文件系统和路由机制，只允许授权用户访问这些文档。
1. 在 CI/CD 流程中集成 phpDocumentor
首先，我们需要在 CI/CD 流程中集成 phpDocumentor，以便自动生成最新的文档。以下是一个简单的示例：
安装 phpDocumentor:
立即学习“PHP免费学习笔记（深入）”；
composer require phpdocumentor/phpdocumentor
生成文档:
phpDocumentor -d . -t storage/docs/
这条命令会将当前目录（-d .）下的代码文档生成到 storage/docs/ 目录（-t storage/docs/）下。
重要提示: storage 目录通常会被 .gitignore 文件忽略。如果计划在非生产服务器上生成 phpDocs，务必确保 storage/docs/ 目录及其内容能够被推送到生产服务器。
2. 配置 Laravel 文件系统
接下来，我们需要配置 Laravel 的文件系统，以便能够访问 storage/docs/ 目录下的文档。
打开 config/filesystem.php 文件，在 ‘disks’ 数组中添加一个新的磁盘：
'disks' => [ // ... other disks 'local-docs' => [ 'driver' => 'local', 'root' => storage_path('docs'), ],],
这个配置定义了一个名为 local-docs 的磁盘，它使用 local 驱动，并将根目录设置为 storage_path(‘docs’)，即 storage/docs/ 目录的绝对路径。
3. 创建路由和中间件
现在，我们需要创建一个路由来提供文档，并使用中间件来确保只有经过身份验证的用户才能访问该路由。
打开 routes/web.php 文件，添加以下路由：
use IlluminateSupportFacadesRoute;use IlluminateSupportFacadesStorage;use GuzzleHttpPsr7MimeType;Route::get('/docs/{url?}', function ($url = null) { $path = $url ? $url : 'index.html'; // 默认显示 index.html if (!Storage::disk('local-docs')->exists($path)) { abort(404); // 文件不存在时返回 404 } $file = Storage::disk('local-docs')->get($path); $type = MimeType::fromFilename($path); return response($file, 200)->header('Content-Type', $type);})->where('url', '(.*)')->middleware('auth');
这个路由做了以下几件事：
Route::get(‘/docs/{url?}’, …)：定义了一个 GET 路由，匹配 /docs/ 后面的任意 URL。{url?} 表示 url 参数是可选的。function ($url = null) { … }：定义了一个匿名函数，处理路由的请求。$url 参数接收 URL 的值。如果 $url 为空（即访问 /docs/），则设置默认显示 index.html。Storage::disk(‘local-docs’)->exists($path)：检查指定路径的文件是否存在于 local-docs 磁盘上。如果不存在，则返回 404 错误。Storage::disk(‘local-docs’)->get($path)：从 local-docs 磁盘读取指定路径的文件内容。MimeType::fromFilename($path)：根据文件名获取 MIME 类型。response($file, 200)->header(‘Content-Type’, $type)：创建一个 HTTP 响应，包含文件内容、状态码 200 (OK) 和 Content-Type 头部。->where(‘url’, ‘(.*)’)：使用正则表达式约束 url 参数，允许包含任意字符。->middleware(‘auth’)：应用 auth 中间件，确保只有经过身份验证的用户才能访问该路由。
重要提示: 确保没有其他路由使用了 docs 前缀，否则可能会导致冲突。
4. 总结
通过以上步骤，我们成功地将 phpDocumentor 生成的文档安全地托管在了 Laravel 项目中。只有经过身份验证的用户才能访问 /docs/ 路由，并且可以通过 URL 参数访问不同的文档页面，例如 /docs/classes/App/Models/User.html。
注意事项:
确保 auth 中间件已正确配置，并且用户已登录。根据实际需求，可以自定义 auth 中间件，例如使用自定义的权限验证逻辑。可以根据需要修改路由的 URL 前缀。定期更新 phpDocumentor 和文档，以确保文档的准确性和完整性。如果使用了缓存，需要确保在更新文档后清除缓存。
以上就是Laravel 中安全地托管 phpDocumentor 生成的文档的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1324251.html
微信扫一扫 
支付宝扫一扫 
