Así que estoy usando phpDocumentor 3 para generar documentación para mi proyecto Laravel 7,
y me preguntaba si podría servir esta documentación (archivos estáticos) de Laravel para que esté disponible solo para usuarios autorizados .
Me gustaría poder actualizar la documentación a través de mi CI/CD , por lo que no puedo simplemente modificar manualmente la documentación generada.
Creo que podría tener que escribir mi propia plantilla ( https://docs.phpdoc.org/3.0/guide/guides/templates.html ) para eso, pero no estoy seguro de si la documentación está incompleta o si estoy me falta algo porque no tengo idea de cómo crear una plantilla. ¿Alguna sugerencia, guía o tutorial que pueda ayudarme a lograr esto, por favor?
Gracias
Puede incluir la generación de phpDoc dentro de su script de CI/CD:
primero instale phpDocumentor en la producción, luego genere usando este comando:
phpDocumentor -d . -t storage/docs/Nota: la ruta
storagepuede ser ignorada si planea generar los phpDocs, no en el servidor de producción, debe asegurarse de que la carpeta se envíe a la producción
agregue esto a los 'discos' de config/filesystem.php :
'local-docs' => [ 'driver' => 'local', 'root' => storage_path('docs'), ], y agregue lo siguiente en su archivo de rutas ( routes/web.php )
Route::get('/docs/{url?}', function ($url) { $resp = response(Storage::disk('local-docs')->get($url)); $resp->header('content-type', GuzzleHttp\Psr7\MimeType::fromFilename($url)); return $resp; })->where('url', '(.*)')->middleware('auth');asegúrese de que no tiene ninguna otra ruta con el prefijo
docs