Hey fellow rubyists, Last week, Michael Cordell gave an excellent talk at SD Ruby about APIs. I think he mentioned swagger for docs but I'm wondering if others are using swagger or apipie. I am trying to do an accurate comparison of the two. This is my assessment so far, do any of you have any feedback? To me, apipie has some advantages but I'm wondering if I'm missing something that makes swagger so appealing.
Here's my list so far: Apipie: https://github.com/Apipie/apipie-rails PROS: 1. Easy to use, friendly dsl for defining API docs. 2. Api doc server lives with Ruby on Rails app, can be mapped to something like http://myapi.api/api-docs 3. Includes validation or params, throws Apipie::ParamMissing,Apipie::UnknownParam or Apipie::ParamInvalid 4. There’s a nice write-up here about how to have your docs live outside the controller (if that is the hangup) http://ilyabylich.svbtle.com/apipie-amazing-tool-for-documenting-your-rails-api CONS: 1. Syntax may be non-standard to non-ruby devolpers. 2. Api docs only live in the app, can’t be exported to JSON. Swagger-docs: https://github.com/richhollis/swagger-docs PROS: 1. Easy to use, friendly dsl for defining API docs. 2. More cross platform/portable in that docs are spit out in JSON CONS: 1. Requires separate swagger-ui server running to view docs 2. Requires exporting API docs from rails app via rake task and then importing them into swagger-ui server to view. If you have made it this far in the message, I would also like to shamelessly plug our "Active Rubyists" hike at the end of the month, RSVP here: http://www.meetup.com/sdruby/events/223049259/ All the best, Kevin -- -- SD Ruby mailing list [email protected] http://groups.google.com/group/sdruby --- You received this message because you are subscribed to the Google Groups "SD Ruby" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. For more options, visit https://groups.google.com/d/optout.
