Choosing a Rails API documentation generator

I ended up building a Minitest-based one in-house, with plans to open source. Stay tuned to my github account.

• RSpec-based solutions
  • Problems with RSpec
    • Not Rails default
    • Doesn’t support Rails native parallel testing
    • No built-in support for Rails generator tests
  • Useful tools
    • Turbo_tests allows specs to run in parallel
      • Extracted from Discourse/Rubygems
    • Flatware allows specs to run in parallel
      • Maintained by Hashrocket
      • Slower than turbo_tests due to reliance on drb
  • Generators
    • rswag
    • rspec-openapi
    • Abandoned: dox
    • Abandoned: rspec_api_documentation
• Non-RSpec solutions
  • apipie
    • Declare api metadata straight in the controllers
    • Only OpenAPI 2.0 (no 3.0 and above)

---

---

---

---