apigenでLaravelのAPI一覧を生成する

Tags : Laravel4  

PHPのAPIドキュメント生成には、いくつか種類がありますが、スピードでapigenを選択しています。ドキュメントサイトで公開しているAPIも、これで生成したものです。

基本的な使用方法はこちらのサイトで紹介されています。

ドキュメントサイトで使用している設定ファイルは以下の通りです。パスは適宜修正してください。neon形式です。

#
# apigen サンプル設定ファイル
#
# この設定ファイルはapigenのオプション設定ファイルです。
# NEON形式で記述されています。
#
#
# 指定方法:apigenの-cオプションでこのファイルを指定します。
#
# apigen -c apigen.neon
#
#
# このサンプルのオプションは
# Laravelのルートに設置され、ルートでapigenコマンドが
# 実行される前提で記述しています。
#
# 各オプションの意味はコメントをご覧ください
#

# API生成対象ファイル/ディレクトリー
source: vendor

# 出力先ディレクトリー
destination: api

# 文字コード
charset: UTF-8

# メインプロジェクト名プリフィックス
main: Illuminate

# タイトル
title: Laravel4日本語API

# ダウンロードリンクの生成
download: no

# PHP内部クラスのAPI生成
php: no

# Treeの生成
tree: yes

# 不使用の要素に対しても生成するか
deprecated: no

# ToDoを生成するか
todo: no

# コードのハイライト
sourceCode: no

# 以前に生成したドキュメントを削除するか
wipeout: yes

# パース除外
exclude:
  - */tests/*
  - */build/*
  - */test/*
  - */Tests/*
  - */test-suite/*
  - */example/*
  - */examples/*

# ドキュメントを一般公開する場合の
# サイトマップで使用されるベースURL
baseUrl: http://laravel4.kore1server.com/api/

# Google Analytics コード
googleAnalytics:

# テンプレートの指定
templateConfig: bt/config.neon
#templateConfig: df/config.neon
#  テンプレートはapigenのgithubから入手可能

これを端末から、php apigen.php -c apigen.neonで実行します。