Know what errors lurk in your code? Rollbar detects and alerts you when code breaks in production. Get the stack trace, code, and data to help you d̶e̶b̶u̶g̶ defeat Ruby errors. Learn more.

RubyFlow The Ruby and Rails community linklog

×

The Ruby and Rails community linklog

Made a library? Written a blog post? Found a useful tutorial? Share it with the Ruby community here or just enjoy what everyone else has found!

Guide for Documenting Your Rails API with Swagger

Checkout my latest article Do the Right Thing and Document Your Rails API with Swagger to know about documenting Rails API with Swagger published on SitePoint.

Please share your thoughts and criticism on using Swagger for documentation, also share how you document your rails API?

Thanks, and visit ParthTalks where I share my thoughts on rails.

Comments

from the README of swagger-docs: > This project supports elements of the v1.2 swagger specification. It does not support the v2 specification.

Yes, I haven’t used swagger-blocks yet! swagger-blocks needs to be used for supporting v2. DSL is a bit different.

An alternative getting the information from rspec https://github.com/Wolox/dictum

Post a comment

You can use basic HTML markup (e.g. <a>) or Markdown.

As you are not logged in, you will be
directed via GitHub to signup or sign in