api-blueprint

Semi-automatic solution for creating Rails app's API documentation. Here's how it works:

1. You start with method list generated from RSpec request specs. For each method, you get a list of parameters and examples.
2. Then, you can extend it in whatever way you need using Markdown syntax. You can organize documentation files into partials.
3. Upon any API change, like serializer change that changes responses, you can update automatically generated parts of docs.
4. Once done, you can compile your documentation into single, nicely styled HTML file. You can also auto-deploy it via SSH.

Installation

Add to Gemfile:

gem 'api_blueprint', group: [:development, :test]

Then run:

bundle install

Add the following inside RSpec.configure block in spec/spec_helper.rb:

config.include ApiBlueprint::Collect::SpecHook

Usage

api-blueprint consists of two modules:

1. Collect module: allows to run RSpec request suite in order to auto-generate API method information.
2. Compile module: allows to turn whole Markdown documentation into single, ready-to-publish HTML file.

Collect

In order to auto-generate API method information you should invoke:

rake blueprint:collect

By default, all specs inside spec/requests/api are run. You can configure that by creating a Blueprintfile configuration.

This will generate the doc/api.md file with a Markdown documentation ready to compile. If this file already exists, api-blueprint will not override it. It will write to tmp/merge.md instead so you can merge both existing and generated documentation manually in whatever way you want.

Of course, it's just a starting point and you should at least fill in some resource, action and parameter descriptions. But that's a story for the Compile module.

Regenerate examples

You get the RSpec-based example listing for every auto-generated API method documentation. There's a chance that

Compile

Note, please add sass gem to your dependencies before compiling the documentation.

In order to turn your documentation into ready-to-publish HTML file you should invoke:

rake blueprint:compile

This will create the final doc/api.html. You can deploy this file to configured SSH target with:

rake blueprint:deploy

If you want to preview this file constantly when editing Markdown docs, you can do so with:

rake blueprint:watch

You should add doc/**/*.html to your .gitignore as there's no need to clutter your project history with compiled HTML that you can easily recreate on demand.

Require another file

You can split your documentation into separate files and directories in order to organize it better and reuse same fragments in multiple places. You can do that with the following Markdown:

<require:fragments/deprecation_warning.md>

Configuration

Configuration for api-blueprint lives in Blueprintfile inside application directory. It's basically a listing of documentations governed by api-blueprint, each with a set of options. It looks like this:

api:
  spec: "spec/requests/api/v2"
  blueprint: "doc/api.md"
  html: "doc/api.html"
  deploy: "user@server.com:/home/app/public/api.html"
  naming:
    sessions:
      create: "Sign In"
  rspec_options:
    tag: documentation

Here's what specific per-documentation options stand for:

Option	Description
spec	RSpec spec suite directory
blueprint	Main documentation file (Markdown)
html	Target HTML file created after compilation
deploy	SSH address used for documentation deployment
naming	Dictionary of custom API method names
rspec_options	Dictionary of command line options to pass to rspec when generating docs (Allows targeting of specs based off tags)

First group is always a default one. You can switch any rake task to work on other group by specifying its name with rake blueprint:collect group=other.

Adding descriptions

    before do
      set_description 'Allows a user to "like" a piece of content specified by item_uuid and item_type'
      set_param_description(:item_uuid, 'uuid of the item a user is to rate')
      set_param_description(:item_type, 'type of item.  Currently only supports `episode`')
      set_param_definition(:rating, 'string', '1' 'Score to rate the item.  Currently must be either 1 or -1')

      # For nested params, pass an array corresponding to the keys
      set_param_description([:comment, :message], 'Content of the comment the user is leaving.')
      set_param_definition([:comment, :topic_uuid], 'string', SecureRandom.uuid, 'uuid of the item a user is commenting on')
    end