|
1 |
| -# Grape::Entity |
2 |
| - |
3 | 1 | [](http://badge.fury.io/rb/grape-entity)
|
4 |
| -[](https://travis-ci.org/ruby-grape/grape-entity) |
| 2 | + |
5 | 3 | [](https://coveralls.io/github/ruby-grape/grape-entity?branch=master)
|
6 | 4 | [](https://codeclimate.com/github/ruby-grape/grape-entity)
|
7 | 5 |
|
| 6 | +# Table of Contents |
| 7 | + |
| 8 | +- [Grape::Entity](#grapeentity) |
| 9 | + - [Introduction](#introduction) |
| 10 | + - [Example](#example) |
| 11 | + - [Reusable Responses with Entities](#reusable-responses-with-entities) |
| 12 | + - [Defining Entities](#defining-entities) |
| 13 | + - [Basic Exposure](#basic-exposure) |
| 14 | + - [Exposing with a Presenter](#exposing-with-a-presenter) |
| 15 | + - [Conditional Exposure](#conditional-exposure) |
| 16 | + - [Safe Exposure](#safe-exposure) |
| 17 | + - [Nested Exposure](#nested-exposure) |
| 18 | + - [Collection Exposure](#collection-exposure) |
| 19 | + - [Merge Fields](#merge-fields) |
| 20 | + - [Runtime Exposure](#runtime-exposure) |
| 21 | + - [Unexpose](#unexpose) |
| 22 | + - [Overriding exposures](#overriding-exposures) |
| 23 | + - [Returning only the fields you want](#returning-only-the-fields-you-want) |
| 24 | + - [Aliases](#aliases) |
| 25 | + - [Format Before Exposing](#format-before-exposing) |
| 26 | + - [Expose Nil](#expose-nil) |
| 27 | + - [Documentation](#documentation) |
| 28 | + - [Options Hash](#options-hash) |
| 29 | + - [Passing Additional Option To Nested Exposure](#passing-additional-option-to-nested-exposure) |
| 30 | + - [Attribute Path Tracking](#attribute-path-tracking) |
| 31 | + - [Using the Exposure DSL](#using-the-exposure-dsl) |
| 32 | + - [Using Entities](#using-entities) |
| 33 | + - [Entity Organization](#entity-organization) |
| 34 | + - [Caveats](#caveats) |
| 35 | + - [Installation](#installation) |
| 36 | + - [Testing with Entities](#testing-with-entities) |
| 37 | + - [Project Resources](#project-resources) |
| 38 | + - [Contributing](#contributing) |
| 39 | + - [License](#license) |
| 40 | + - [Copyright](#copyright) |
| 41 | + |
| 42 | +# Grape::Entity |
| 43 | + |
8 | 44 | ## Introduction
|
9 | 45 |
|
10 | 46 | This gem adds Entity support to API frameworks, such as [Grape](https://github.com/ruby-grape/grape). Grape's Entity is an API focused facade that sits on top of an object model.
|
|
0 commit comments