Menu
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
947
Apipie-rails is a DSL and Rails engine for documenting you RESTful API. Instead of traditional use of #comments, Apipie lets you "describe the code by code". This brings advantages like: It uses ruby syntax. Reusable doc for other purposes (Best for validations)
REST stands for REpresentational State Transfer and describes resources (in our case URLs) on which we can perform actions. CRUD , which stands for Create, Read, Update, Delete, are the actions that we perform. Although, in Rails, REST and CRUD are bestest buddies, the two can work fine on their own.
Well, I found Slate one of the best out there.
89
If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!
Donate Us With
