ApiGen 安裝與快速上手指南

ApiGen 安裝與快速上手指南

ApiGen 是 PHP 專案主流的 API 文件生成工具，支援 PHP 8+、屬性、介面、Traits 等現代語法。本文說明跨平台安裝與驗證流程。

1. 下載 PHAR 檔案

官網：https://apigen.org/apigen.phar

2. *nix 系統 (Linux/macOS) 安裝

# 移動至 PATH 目錄並賦予執行權限
mv apigen.phar /usr/local/bin/apigen
chmod +x /usr/local/bin/apigen

# 驗證
apigen --version
# 輸出: ApiGen version v4.x.x

之後可直接使用 apigen 指令，無需 php apigen.phar。

3. Windows 系統安裝

1. 將 apigen.phar 放入環境變數 PATH 目錄 (如 C:\bin)。
2. 在該目錄開啟 CMD，生成批次檔：

C:\bin> echo @php "%~dp0apigen.phar" %* > apigen.bat

3. 新開 CMD 驗證：

C:\Users\username> apigen
ApiGen version v4.0.0

4. 常見問題排查

• PHP 版本不符：ApiGen 4.x 需 PHP 7.1+，請升級 PHP。
• phar 擴展未啟用：檢查 php.ini 確認 extension=phar。
• 權限不足：Linux/macOS 需 chmod +x；Windows 需以管理員身份執行 CMD 寫入 PATH 目錄。

5. 下一步：生成專案文件

apigen generate -s src -d docs/api --title "My Project API"

詳細配置選項請參考 ApiGen 4.0 配置項完整表。