API Documentation tool for Rails 5 [closed]
Asked Answered
H

2

8

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

Helpless answered 9/2, 2018 at 7:38 Comment(0)
H
5

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

Helpless answered 29/10, 2018 at 7:12 Comment(0)
S
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/

Sommelier answered 9/2, 2018 at 9:2 Comment(1)
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?Helpless

© 2022 - 2024 — McMap. All rights reserved.