<commit_before># JSONAPI::Resources [![Build Status](https://secure.travis-ci.org/cerebris/jsonapi-resources.png?branch=master)](http://travis-ci.org/cerebris/jsonapi-resources) [![Code Climate](https://codeclimate.com/github/cerebris/jsonapi-resources/badges/gpa.svg)](https://codeclimate.com/github/cerebris/jsonapi-resources)

`JSONAPI::Resources`, or "JR", provides a framework for developing a server that complies with the
[JSON API](http://jsonapi.org/) specification.

Like JSON API itself, JR's design is focused on the resources served by an API. JR needs little more than a definition
of your resources, including their attributes and relationships, to make your server compliant with JSON API.

JR is designed to work with Rails 4.0+, and provides custom routes, controllers, and serializers. JR's resources may be
backed by ActiveRecord models or by custom objects.

## Table of Contents

* [Demo App] (#demo-app)
* [Client Libraries] (#client-libraries)
* [Installation] (#installation)
* [Usage] (#usage)
  * [Resources] (#resources)
    * [JSONAPI::Resource] (#jsonapiresource)
    * [Attributes] (#attributes)
    * [Primary Key] (#primary-key)
    * [Model Name] (#model-name)
    * [Relationships] (#relationships)
    * [Filters] (#filters)
    * [Pagination] (#pagination)
    * [Included relationships (side-loading resources)] (#included-relationships-side-loading-resources)
    * [Callbacks] (#callbacks)
  * [Controllers] (#controllers)
    * [Namespaces] (#namespaces)
    * [Error Codes] (#error-codes)
  * [Serializer] (#serializer)
* [Contributing] (#contributing)
* [License] (#license)

## Demo App

We have a simple demo app, called [Peeps](https://github.com/cerebris/peeps), available to show how JR is used.

## Client Libraries<commit_msg>Add configuration to TOC<commit_after># JSONAPI::Resources [![Build Status](https://secure.travis-ci.org/cerebris/jsonapi-resources.png?branch=master)](http://travis-ci.org/cerebris/jsonapi-resources) [![Code Climate](https://codeclimate.com/github/cerebris/jsonapi-resources/badges/gpa.svg)](https://codeclimate.com/github/cerebris/jsonapi-resources)

`JSONAPI::Resources`, or "JR", provides a framework for developing a server that complies with the
[JSON API](http://jsonapi.org/) specification.

Like JSON API itself, JR's design is focused on the resources served by an API. JR needs little more than a definition
of your resources, including their attributes and relationships, to make your server compliant with JSON API.

JR is designed to work with Rails 4.0+, and provides custom routes, controllers, and serializers. JR's resources may be
backed by ActiveRecord models or by custom objects.

## Table of Contents

* [Demo App] (#demo-app)
* [Client Libraries] (#client-libraries)
* [Installation] (#installation)
* [Usage] (#usage)
  * [Resources] (#resources)
    * [JSONAPI::Resource] (#jsonapiresource)
    * [Attributes] (#attributes)
    * [Primary Key] (#primary-key)
    * [Model Name] (#model-name)
    * [Relationships] (#relationships)
    * [Filters] (#filters)
    * [Pagination] (#pagination)
    * [Included relationships (side-loading resources)] (#included-relationships-side-loading-resources)
    * [Callbacks] (#callbacks)
  * [Controllers] (#controllers)
    * [Namespaces] (#namespaces)
    * [Error Codes] (#error-codes)
  * [Serializer] (#serializer)
* [Configuration] (#configuration)
* [Contributing] (#contributing)
* [License] (#license)

## Demo App

We have a simple demo app, called [Peeps](https://github.com/cerebris/peeps), available to show how JR is used.

## Client Libraries
{'fraction_non_alphanumeric': 0.13952195664257921, 'fraction_numerical': 0.0011117287381878821, 'mean_word_length': 4.988352745424293, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 8, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5336698', 'n_tokens_mistral': 1146, 'n_tokens_neox': 1068, 'n_words': 320}