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

rails で RESTful APIを作るに当たって、ドキュメンテーションツールを導入してみました 背景 rails でフロントとバックエンドと別々の担当者が作業しようとしたときに、フロントから受け渡されるべきパラメーターはなんで、その結果どんな結果がわたるのかどうやってドキュメントしようかなと。。 javadocみたいに定番の書式があるわけではなさそうなので、gem周りで検索してみました。 さらに、世の中の定番としては こんなかんじなのかな https://qiita.com/jian-feng/items/c79955713e6dd8b5244a 結果としてたどり着いたのが、 apipie-rails です 何が出来るのか ソースコード上にDSLを使ってAPIインターフェースを定義できる Webサーバー経由でHtmlドキュメントとして可視化された情報にアクセス出来る 引数のバリデーシ