rails-api apipie-rails

Let's make an API-only-app and how to document it.

Presented by Hasim Sofaruddin / @simudin

What is an API app?

Rails::API

Rails::API is a subset of a normal Rails application, created for applications that don't require all functionality that a complete Rails application provides.

Basic Configuration

gem install rails-api

Apipie-rails

An API Documentation Tool

What is apipie anyway?

Apipie-rails is a DSL and Rails engine for documenting you RESTful API. Instead of traditional use of #comments , Apipie lets you describe the code by code. Apipie brings advantages.

Why apipie?

no need to learn another syntax
possibility reuse the doc for other purposes (such as validation)
easier to extend and maintain
possibility to use other sources for documentation purposes (such as routes etc.)

Basic Conf

gem 'apipie-rails'

Take a Moment

Press b or period on your keyboard to enter the 'paused' mode. This mode is helpful when you want to take distracting slides off the screen during a presentation.