本文介紹如何利用 Laravel 框架，安全地提供 phpDocumentor 生成的文檔，使其僅對授權(quán)用戶可見。通過配置 CI/CD 流程，自動生成文檔并存儲在指定目錄，然后通過自定義路由和中間件，實現(xiàn)文檔的訪問控制，確保只有登錄用戶才能訪問項目文檔。

使用 Laravel 安全地托管 phpDocumentor 文檔

phpDocumentor 是一款強(qiáng)大的 PHP 文檔生成工具，可以根據(jù)代碼中的注釋自動生成 API 文檔。然而，在某些情況下，我們希望這些文檔只能被授權(quán)用戶訪問，例如團(tuán)隊內(nèi)部成員。本文將介紹如何利用 Laravel 框架，安全地托管 phpDocumentor 生成的文檔，并實現(xiàn)訪問控制。

步驟 1: 生成 phpDocumentor 文檔

首先，需要在你的 Laravel 項目中安裝 phpDocumentor。你可以通過 Composer 來完成：

composer require phpdocumentor/phpdocumentor

安裝完成后，就可以使用 phpDocumentor 生成文檔了。在你的 CI/CD 腳本中添加以下命令：

立即學(xué)習(xí)“PHP免費(fèi)學(xué)習(xí)筆記（深入）”；

phpDocumentor -d . -t storage/docs/

這條命令會將當(dāng)前目錄（-d .）下的代碼生成文檔，并輸出到 storage/docs/ 目錄（-t storage/docs/）。

重要提示：

• 請確保 storage/docs/ 目錄不會被 .gitignore 文件忽略。如果該目錄被忽略，生成的文檔將不會被推送到生產(chǎn)服務(wù)器，導(dǎo)致無法訪問。
• 根據(jù)你的項目結(jié)構(gòu)和需求，調(diào)整 -d 和 -t 參數(shù)。

步驟 2: 配置 Filesystem Disk

為了方便 Laravel 管理生成的文檔，我們需要在 config/filesystem.php 文件中添加一個新的 disk 配置：

夸克文檔

夸克文檔智能創(chuàng)作工具，支持AI寫作/AIPPT/AI簡歷/AI搜索等

52

查看詳情

'disks' => [

    // ... other disks

    'local-docs' => [
        'driver' => 'local',
        'root' => storage_path('docs'),
    ],
],

這個配置定義了一個名為 local-docs 的 disk，它使用 local 驅(qū)動，并將根目錄指向 storage/docs/。

步驟 3: 創(chuàng)建路由并應(yīng)用中間件

接下來，我們需要創(chuàng)建一個路由來提供文檔服務(wù)，并應(yīng)用 auth 中間件來限制訪問。在 routes/web.php 文件中添加以下代碼：

use Illuminate\Support\Facades\Route;
use Illuminate\Support\Facades\Storage;
use GuzzleHttp\Psr7\MimeType;

Route::get('/docs/{url?}', function ($url = null) {
    if (is_null($url)) {
        $url = 'index.html'; // Or your default doc page
    }
    if (!Storage::disk('local-docs')->exists($url)) {
        abort(404);
    }
    $resp = response(Storage::disk('local-docs')->get($url));
    $resp->header('content-type', MimeType::fromFilename($url));
    return $resp;

})->where('url', '(.*)')->middleware('auth');

這段代碼定義了一個 /docs/{url?} 路由，它可以接收一個可選的 URL 參數(shù)。

• 如果 URL 參數(shù)為空，則默認(rèn)加載 index.html 文件（或者你的文檔首頁）。
• 使用 Storage::disk('local-docs')->get($url) 讀取指定的文件內(nèi)容。
• 使用 GuzzleHttp\Psr7\MimeType::fromFilename($url) 獲取文件的 MIME 類型，并設(shè)置響應(yīng)頭。
• 使用 middleware('auth') 應(yīng)用 auth 中間件，確保只有登錄用戶才能訪問該路由。
• 如果文件不存在，返回404錯誤。

重要提示：

• 確保沒有其他路由使用了 docs 前綴，否則可能會導(dǎo)致沖突。
• 如果你的文檔首頁不是 index.html，請修改默認(rèn) URL。

步驟 4: 訪問文檔

現(xiàn)在，你可以通過訪問 /docs 路由來查看你的 phpDocumentor 文檔了。只有登錄用戶才能訪問這些文檔。

總結(jié)

通過以上步驟，你已經(jīng)成功地將 phpDocumentor 生成的文檔安全地托管在 Laravel 框架中。這種方法不僅可以方便地管理文檔，還可以有效地控制文檔的訪問權(quán)限，確保只有授權(quán)用戶才能查看。記得在 CI/CD 流程中添加文檔生成步驟，并定期更新文檔，以保持文檔的準(zhǔn)確性和完整性。

以上就是Laravel 中安全地提供 phpDocumentor 生成的文檔的詳細(xì)內(nèi)容，更多請關(guān)注php中文網(wǎng)其它相關(guān)文章！