https://github.com/Apipie/apipie-rails

APIドキュメントを簡単に作成できるgem。
例えば、https://secure.freee.co.jp/developers/api/doc がこれで作られてると思われる。

この前はじめて使ったんだけど、Examples Recordingがめっちゃ便利だった。
https://github.com/Apipie/apipie-rails#examples-recording

describe "This is the correct path" do
  it "some test", :show_in_doc do
  end
end

RSpec.configure do |config|
  config.filter_run :show_in_doc => true if ENV['APIPIE_RECORD']
end

$ APIPIE_RECORD=examples bundle exec rspec

こんな感じでやれば、テスト結果をサンプルとしてドキュメント内に表示してくれる。
なお、jbuilderを使ってる場合は、render_viewsが必要。これもちゃんとREADMEに書いてある。

便利な世の中だ、、、

---

Unable to autoload constant Concerns::Foo

https://github.com/Apipie/apipie-rails/issues/347

config/initializers/apipie.rb

config.api_controllers_matcher = "#{Rails.root}/app/controllers/api/**/*.rb" # api以下に絞る

でひとまず逃げた。