rails の API doc作成ツール apipie-rails

rails で RESTful APIを作るに当たって、ドキュメンテーションツールを導入してみました

背景

rails でフロントとバックエンドと別々の担当者が作業しようとしたときに、フロントから受け渡されるべきパラメーターはなんで、その結果どんな結果がわたるのかどうやってドキュメントしようかなと。。

javadocみたいに定番の書式があるわけではなさそうなので、gem周りで検索してみました。

さらに、世の中の定番としては こんなかんじなのかな
https://qiita.com/jian-feng/items/c79955713e6dd8b5244a

結果としてたどり着いたのが、 apipie-rails です

何が出来るのか

1. ソースコード上にDSLを使ってAPIインターフェースを定義できる
2. Webサーバー経由でHtmlドキュメントとして可視化された情報にアクセス出来る
3. 引数のバリデーションをする → ArgumentError exception が上がる

導入

1. "gem 'apipie-rails'" を追加（一旦、開発環境のみに導入されるように設定する）
2. bundle install 後、rails g apipie:install で以下が追加されました a. routes.rb に apipie ルートが追加 b. config/initializers/apipie.rb が追加