---
name: "Jifty::Plugin::REST"
section: "3pm"
platform: "linux"
package: "libjifty-perl"
version: "1.10518+dfsg-2"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/Jifty::Plugin::REST"
---

# Jifty::Plugin::REST(3pm)

Add REST web services to your app

## NAME

Jifty::Plugin::REST - Add REST web services to your app

## DESCRIPTION

A RESTful web services API for your Jifty app.

## USAGE

Add the following to your site\_config.yml

```
 framework:
   Plugins:
     - REST: {}
```

See the URL /=/help in your Jifty app for more information about how to access the REST resources.

## MISC

The REST interface calls a method named `"jifty_serialize_format"` on records and collections to downgrade them to simple data structures. By default, this just lists the attributes specified with "column".  If you want to include calculated values in your REST interface, you can do so by overriding `"jifty_serialize_format"`.
