REST API Documentation for Rails
Minimum price
Suggested price

REST API Documentation for Rails

A complete guide on creating RESTful API Documentation for your Ruby on Rails application.

About the Book

In this book we are going to cover how to use a tool called rswag (along with a few others), which allows us to write rspec tests which can be used to generate our API documentation. The benefit of using tests for our API docs is that if you make changes to your code that effect your API and re-run the specs, the tests should fail, signifying that you need to update the specs. This will ensure that your API documentation is always up to date.

  • Share this book

  • Categories

    • APIs
    • Computers and Programming
    • Ruby
    • Ruby on Rails
    • Testing
    • API Design
  • Feedback

    Email the Author(s)

About the Author

Blake Erickson
Blake Erickson

HI! I'm Blake Erickson. I've been a software developer since 2009 where I've worked on many different software projects, in many different languages. Currently I love making web apps with Ruby and Javascript.

I write about programming at and you can follow me on twitter @oblakeerickson.

Table of Contents

    • Introduction
      • Why this book?
    • Getting Started
    • RSwag Setup
    • Redoc Setup
    • GitHub Pages Setup
    • JSON Schema Setup

The Leanpub 60 Day 100% Happiness Guarantee

Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.

Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.

You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!

So, there's no reason not to click the Add to Cart button, is there?

See full terms...

80% Royalties. Earn $16 on a $20 book.

We pay 80% royalties. That's not a typo: you earn $16 on a $20 sale. If we sell 5000 non-refunded copies of your book or course for $20, you'll earn $80,000.

(Yes, some authors have already earned much more than that on Leanpub.)

In fact, authors have earnedover $13 millionwriting, publishing and selling on Leanpub.

Learn more about writing on Leanpub

Free Updates. DRM Free.

If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).

Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.

Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.

Learn more about Leanpub's ebook formats and where to read them

Write and Publish on Leanpub

You can use Leanpub to easily write, publish and sell in-progress and completed ebooks and online courses!

Leanpub is a powerful platform for serious authors, combining a simple, elegant writing and publishing workflow with a store focused on selling in-progress ebooks.

Leanpub is a magical typewriter for authors: just write in plain text, and to publish your ebook, just click a button. (Or, if you are producing your ebook your own way, you can even upload your own PDF and/or EPUB files and then publish with one click!) It really is that easy.

Learn more about writing on Leanpub