Apipie-railsはRuby/Ruby on Rails用のオープンソース・ソフトウェア(MIT License)です。 システムのドキュメンテーションは一定の規模になってくると必然的に必要になります。特にRESTfulなどでWeb APIを提供している場合はそうです。そこでフレームワークにRuby on Railsを用いてる方にお勧めしたいドキュメンテーションシステムがApipie-railsです。 インストールした後、ジェネレートします。 例えばこのように記述します。コントローラのメソッドの上部に記述するイメージです。 Apipeiのルートにアクセスします。ドキュメントを作成しているリソースが一覧されます。 メソッドの説明です。必要な引数などが説明されています。 Apipie-railsではメソッドの説明やAPIのバージョン、エラーについて、引数などを一覧で書きます。一般的にこの