API Documentation tool for Rails 5

Question

I have an API only rails app which needs documentation for frontend developers. And it's my first experience with it.

What tool do you use for this purpose? Note that I am using rails 5 API and not Grape.

I tested Apipie, swagger-blocks, and swagger-docs gems, but they are obsolete or buggy. There must be a better option!
Any recommendations respected

score 5 · Answer 1 · answered Oct 29 '18 at 07:12

5

Well, I found Slate one of the best out there.

answered Oct 29 '18 at 07:12

MalekMFS

180
2
13

score 2 · Answer 2 · answered Feb 09 '18 at 09:02

2

did you try RSpec Api Documentation? https://github.com/zipmark/rspec_api_documentation

There is an article on using it with codeship here: https://blog.codeship.com/producing-documentation-for-your-rails-api/

answered Feb 09 '18 at 09:02

Paul Harker

166
2
14

Thanks for your response. I never used rspec before but wrote tests with simple rails test unit. Do you still prefer it to me? Can i run it fast? – MalekMFS Feb 09 '18 at 09:16

API Documentation tool for Rails 5

2 Answers2