Email the Author

You can use this page to email Blake Erickson about REST API Documentation for Rails.

Please include an email address so the author can respond to your query

This message will be sent to Blake Erickson

This site is protected by reCAPTCHA and the Google  Privacy Policy and  Terms of Service apply.

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.


About the Author

Blake Erickson’s avatar Blake Erickson

@oblakeerickson

Instagram

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 blake.app and you can follow me on twitter @oblakeerickson.

Logo white 96 67 2x

Publish Early, Publish Often

  • Path
  • There are many paths, but the one you're on right now on Leanpub is:
  • Railsapidocs › Email Author › New
    • READERS
    • Newsletters
    • Weekly Sale
    • Monthly Sale
    • Store
    • Home
    • Redeem a Token
    • Search
    • Support
    • Leanpub FAQ
    • Leanpub Author FAQ
    • Search our Help Center
    • How to Contact Us
    • FRONTMATTER PODCAST
    • Featured Episode
    • Episode List
    • MEMBERSHIPS
    • Reader Memberships
    • Department Reader Memberships
    • Author Memberships
    • Your Membership
    • COMPANY
    • About
    • About Leanpub
    • Blog
    • Contact
    • Press
    • Essays
    • AI Services
    • Imagine a world...
    • Manifesto
    • More
    • Partner Program
    • Causes
    • Accessibility
    • AUTHORS
    • Write and Publish on Leanpub
    • Create a Book
    • Create a Bundle
    • Create a Course
    • Create a Track
    • Testimonials
    • Why Leanpub
    • Services
    • TranslateAI
    • TranslateWord
    • TranslateEPUB
    • PublishWord
    • Publish on Amazon
    • CourseAI
    • GlobalAuthor
    • Marketing Packages
    • IndexAI
    • Author Newsletter
    • The Leanpub Author Update
    • Author Support
    • Author Help Center
    • Leanpub Authors Forum
    • The Leanpub Manual
    • Supported Languages
    • The LFM Manual
    • Markua Manual
    • API Docs
    • Organizations
    • Learn More
    • Sign Up
    • LEGAL
    • Terms of Service
    • Copyright Policy
    • Privacy Policy
    • Refund Policy

*   *   *

Leanpub is copyright © 2010-2025 Ruboss Technology Corp.
All rights reserved.

This site is protected by reCAPTCHA
and the Google  Privacy Policy and  Terms of Service apply.

Leanpub requires cookies in order to provide you the best experience. Dismiss