Symfoware

Symfowareについての考察blog

APIドキュメント生成ツール apidoc をDebian 9にインストール

APIドキュメント生成ツール「apidoc」
http://apidocjs.com/

Debian 9にインストールしてみます。
こちらを参考にしました。
PHPでのAPIドキュメント作成ツール(RESTful APIとソースコードドキュメント生成)



node,npmのインストール



node製のツールなので、nodejsとnpmをインストールします。

こちらを参考にしました。
How to Install Latest Nodejs & NPM on Debian 9/8/7


# apt install curl
# curl -sL https://deb.nodesource.com/setup_8.x | bash -
# apt install nodejs




node,npmともに最新版がインストールできました。


# node -v
v8.4.0

# npm -v
5.3.0







apidocのインストールとドキュメントの生成



npmの準備ができたら、apidocをインストールします。


# npm install apidoc -g




インストールできました。


# apidoc -h

Usage: /usr/bin/nodejs apidoc [options]






ドキュメントの生成コマンドは以下の通り


apidoc -i [ソースのディレクトリ] -o [ドキュメントの出力ディレクトリ]




/var/dev/php/sample.phpを作成。
以下の内容を記載しました。


  1. <?php
  2. /**
  3. * @api {get} /user/:id Request User information
  4. * @apiName GetUser
  5. * @apiGroup User
  6. *
  7. * @apiParam {Number} id Users unique ID.
  8. *
  9. * @apiSuccess {String} firstname Firstname of the User.
  10. * @apiSuccess {String} lastname Lastname of the User.
  11. */




APIドキュメント出力用のディレクトリを作成。


# mkdir -p /var/dev/apidoc




APIドキュメントを出力します。


# apidoc -i /var/dev/php -o /var/dev/apidoc




こんなファイルたちが生成されました。

793_01.png


index.htmlを開くと、APIドキュメントが閲覧できます。

793_02.png



※2017/9/3追記

ドキュメント生成の自動化はこちら。
Linux inotifywait でファイルの更新を監視し、コマンドを実行する




【参考URL】

http://apidocjs.com/
PHPでのAPIドキュメント作成ツール(RESTful APIとソースコードドキュメント生成)
How to Install Latest Nodejs & NPM on Debian 9/8/7

関連記事

テーマ:プログラミング - ジャンル:コンピュータ

  1. 2017/09/03(日) 16:16:29|
  2. 備忘録
  3. | トラックバック:0
  4. | コメント:0
  5. | 編集
<<Linux inotifywait でファイルの更新を監視し、コマンドを実行する | ホーム | 続:SwiftKueryMySQLを利用してMariaDBに接続>>

コメント

コメントの投稿


管理者にだけ表示を許可する

トラックバック

トラックバック URL
http://symfoware.blog68.fc2.com/tb.php/2053-ac9992af
この記事にトラックバックする(FC2ブログユーザー)