ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Apipie-railsはRuby/Ruby on Rails用のオープンソース・ソフトウェア(MIT License)です。

システムのドキュメンテーションは一定の規模になってくると必然的に必要になります。特にRESTfulなどでWeb APIを提供している場合はそうです。そこでフレームワークにRuby on Railsを用いてる方にお勧めしたいドキュメンテーションシステムがApipie-railsです。


インストールした後、ジェネレートします。

例えばこのように記述します。コントローラのメソッドの上部に記述するイメージです。


Apipeiのルートにアクセスします。ドキュメントを作成しているリソースが一覧されます。


メソッドの説明です。必要な引数などが説明されています。

Apipie-railsではメソッドの説明やAPIのバージョン、エラーについて、引数などを一覧で書きます。一般的にこの手のドキュメントはコメントとして記述しますが、Apipie-railsの場合はコードとして書くのが特徴的です。


MOONGIFTはこう見る

システム開発においてドキュメントは嫌われがちですが、それは主に二つの理由によります。一つはムダなドキュメントが多い事、もう一つはメンテナンスコストがかかるということです。

前者においては必要なものだけを選定するのが大事で、APIドキュメントは必須のものと言えるでしょう。そして後者はコードとドキュメントが分離している時に起こります。Apipie-railsはその点をカバーしてくれる便利なツールになるのではないでしょうか。

Pajk/apipie-rails · GitHub

 

MOONGIFTの関連記事

  • DevRel
  • Com2