ApiGenを使ってみる

仕事で使うことになり詰まったので、備忘録として。

環境

• windows
• vagrant
• scotch box(v2.5)
• php 5.5.9
• laravel 5.2.45

今回使うもの

ApiGen

ApiGenとは

phpのドキュメントを自動で作成してくれるパッケージ
今回はv4.1.0を使用予定
最新のバージョンはphp7.1以上を要求されるので、バージョンダウンして使う
*ApiGenの4系はもうサポートされていないらしいので、自己責任で使ってください

インストール方法

• vagrant・laravelは割愛
• laravelプロジェクトのcomposer.jsonにapigenを記述

composer.json

　　　　　・
　　　　　・
　　　　　・
"require-dev": {
        "apigen/apigen": "4.1.*"
    },
　　　　　・
　　　　　・
　　　　　・

• この状態でvagrant sshでlaravelプロジェクトのルート直下でcomposer install
• なにもエラーが出なければ成功

php vendor/apigen/apigen.phar generate -s ./app -d ./docs

• このコマンドを打てば生成される

ApiGen自体のプロジェクトが一度止まってたみたいな記述がある記事を見かけたので、もしかしたらインストールするのに苦労するかもしれません(僕は1週間以上かかりました)