Related works

This section describes some projects sharing more or less the same purpose as Respect for Rails. The goal is to have an overview of the eco-system around this topic to borrow ideas and to drive implementation.

This section is not meant to be accurate even if we try to stay objective here.

apipie-rails

• Documentation generation using an engine.
• Ruby DSL to describe documentation.
• Support validators.
• Resource and controllers description API.
• Good looking generated doc.
• Allow to statically deployed the documentation apart of the Rails app.
• Apparently there is no sanitizer.
• Apparently you can't specify headers.
• Apparently you can't specify url and query parameters.
• Apparently there is no support for json-schema.org standard.

TODO: Study to be continued...

Doctorj

• No Ruby DSL but uses a Markdown file as input.
  • Syntax to describe schema in Markdown looks compact and close to what we have in our Ruby DSL.
• Generate API documentation in HTML.
• Not integrated in Rails.
  • Not bind to the routes.
  • No HTTP headers validation possible.
• No sanitizer.

Rails::API

• Lighter Rails for JSON only application.

Active Model Serializer

• Object oriented way to organize JSON view code.

StrongParameters

• No documentation generation.
• No sanitizer.
• No response validation.