Home

Welcome to the acts_as_api wiki!

Some resources to get you started:

An introduction to acts_as_api

acts_as_api and Mongoid

API Responses

Examples of the default response formats

Differences to the Rails 3 default JSON response structure

DRY API Controllers using Rails 3 Responders

Add meta data (like pagination info) to your response

Advanced examples for API templates

Including a child association

Calling a method of the model

Renaming an attribute

Extending an existing api template

Calling a lambda in the api template

Calling a scope of a sub resource

Conditional statements for adding a field to the api template

Creating a completely different response structure

More Tips and Tricks

Keep your API templates out of your models

Model callbacks (including an example for caching api responses)

A pragmatic approach of API versioning

Use prefixes and postfixes for your templates

Declaring API templates for any class! (no ORMs)

Support custom response formats (example for MessagePack)

Known Problems

"Invalid byte sequence US-ASCII" when installing acts_as_api

---

In case you're using a deprecated version of acts_as_api (> 0.3.0)

Deprecated v 0.2 Readme (does not work with 0.3.0)