forked from jsonapi-rb/jsonapi-rb.github.io
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathrendering.html
More file actions
234 lines (206 loc) · 12.8 KB
/
rendering.html
File metadata and controls
234 lines (206 loc) · 12.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<!doctype html>
<html>
<head>
<meta content="IE=edge" http-equiv="X-UA-Compatible">
<meta charset="utf-8">
<meta content="width=device-width,initial-scale=1.0,minimum-scale=1.0,maximum-scale=1.0,user-scalable=no" name="viewport">
<meta name="description" content="Ruby library for efficiently building and consuming JSON API documents, with Rails and Hanami integrations.">
<meta name="keywords" content="JSONAPI jsonapi JSON API ruby library rails hanami resources efficient">
<link rel="icon" type="image/png" href="/images/favicon.png" />
<title>jsonapi-rb | Efficiently build and consume JSON API documents.</title>
<link href="/stylesheets/toolkit.css" rel="stylesheet" />
<link href="/stylesheets/solarized.css" rel="stylesheet" />
<link href="/stylesheets/application.css" rel="stylesheet" />
<link href="/stylesheets/guides.css" rel="stylesheet" />
</head>
<body>
<nav class="navbar navbar-default navbar-static-top navbar-padded text-uppercase app-navbar">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle collapsed p-x-0" data-toggle="collapse" data-target="#navbar-collapse">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<span>jsonapi-rb</span>
</a>
</div>
<div class="navbar-collapse collapse" id="navbar-collapse">
<ul class="nav navbar-nav navbar-right">
<li>
<a href="/guides">Guides</a>
</li>
<li>
<a href="/contributors.html">Contributors</a>
</li>
<li>
<a href="https://github.com/jsonapi-rb" target="_blank">Source Code</a>
</li>
</ul>
</div><!--/.nav-collapse -->
</div>
</nav>
<div class="container docs-content">
<ul id="markdown-toc">
<li></li>
<li class="toc-group">
<a href="/guides">Introduction</a>
</li>
<li class="toc-group">
Getting started
<ul>
<li><a href="/guides/getting_started/plain_ruby.html">Plain ruby</a></li>
<li><a href="/guides/getting_started/sinatra.html">Sinatra</a></li>
<li><a href="/guides/getting_started/hanami.html">Hanami</a></li>
<li><a href="/guides/getting_started/rails.html">Ruby on Rails</a></li>
</ul>
</li>
<li class="toc-group">
<a href="/guides/serialization">Serialization</a>
<ul>
<li><a href="/guides/serialization/defining.html">Defining resources</a></li>
<li><a href="/guides/serialization/rendering.html">Rendering resources</a></li>
<li><a href="/guides/serialization/errors.html">Rendering errors</a></li>
</ul>
</li>
<li class="toc-group">
<a href="/guides/deserialization">Deserialization</a>
<ul>
<li><a href="/guides/deserialization/defining.html">Defining resources</a></li>
<li><a href="/guides/deserialization/deserializing.html">Deserializing resources</a></li>
</ul>
</li>
</ul>
<h1>Serialization - Rendering documents</h1>
<p>The renderer takes your business objects (which can be any ruby objects: POROs,
ActiveRecord models, or even plain hashes), along with some optional parameters
(<code>include</code>, <code>fields</code>, etc.), and builds the JSON API document.</p>
<h2>Plain ruby</h2>
<p>When using jsonapi-rb in plain ruby (or from within a framework outside of a
controller), you can render a document as follows:</p>
<div class="highlight"><pre class="highlight ruby"><code><span class="no">JSONAPI</span><span class="o">::</span><span class="no">Serializable</span><span class="o">::</span><span class="no">SuccessRenderer</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">posts</span><span class="p">)</span>
</code></pre></div>
<p>You can also pass options to the renderer:</p>
<div class="highlight"><pre class="highlight ruby"><code><span class="no">JSONAPI</span><span class="o">::</span><span class="no">Serializable</span><span class="o">::</span><span class="no">SuccessRenderer</span><span class="p">.</span><span class="nf">render</span><span class="p">(</span><span class="n">posts</span><span class="p">,</span>
<span class="ss">include: </span><span class="p">[</span><span class="ss">:author</span><span class="p">,</span> <span class="ss">comments: </span><span class="p">[</span><span class="ss">:author</span><span class="p">]],</span>
<span class="ss">fields: </span><span class="p">{</span> <span class="ss">users: </span><span class="p">[</span><span class="ss">:name</span><span class="p">,</span> <span class="ss">:email</span><span class="p">],</span>
<span class="ss">posts: </span><span class="p">[</span><span class="ss">:title</span><span class="p">,</span> <span class="ss">:content</span><span class="p">]</span> <span class="p">})</span>
</code></pre></div>
<p>For a comprehensive list of renderer options, see <a href="#renderer_options">Renderer options</a>.</p>
<h2>Ruby on Rails</h2>
<p>When using jsonapi-rb with Rails (via the jsonapi-rails gem), rendering is done
via the usual <code>render</code> controller method:</p>
<div class="highlight"><pre class="highlight ruby"><code><span class="n">render</span> <span class="ss">jsonapi: </span><span class="n">posts</span>
</code></pre></div>
<p>and options are passed as named arguments:</p>
<div class="highlight"><pre class="highlight ruby"><code><span class="n">render</span> <span class="ss">jsonapi: </span><span class="n">posts</span><span class="p">,</span>
<span class="ss">include: </span><span class="p">[</span><span class="ss">:author</span><span class="p">,</span> <span class="ss">comments: </span><span class="p">[</span><span class="ss">:author</span><span class="p">]],</span>
<span class="ss">fields: </span><span class="p">{</span> <span class="ss">users: </span><span class="p">[</span><span class="ss">:name</span><span class="p">,</span> <span class="ss">:email</span><span class="p">],</span>
<span class="ss">posts: </span><span class="p">[</span><span class="ss">:title</span><span class="p">,</span> <span class="ss">:content</span><span class="p">]</span> <span class="p">}</span>
</code></pre></div>
<p>For a comprehensive list of renderer options, see <a href="#renderer_options">Renderer options</a>.</p>
<h2>Hanami</h2>
<p>When using jsonapi-rb with Hanami (via the jsonapi-hanami gem), enabling of
jsonapi-rb features is opt-in, and is done by including
<code>JSONAPI::Hanami::Action</code> in your actions.
Rendering is done by setting options directly on the controller action instance.
The primary data is set via the <code>self.data</code> setter.</p>
<p>Exposures are available from within the <code>SerializableResource</code> class as instance
variables.</p>
<p>Example:</p>
<div class="highlight"><pre class="highlight ruby"><code><span class="k">module</span> <span class="nn">API::Controllers::Posts</span>
<span class="k">class</span> <span class="nc">Create</span>
<span class="kp">include</span> <span class="no">API</span><span class="o">::</span><span class="no">Action</span>
<span class="kp">include</span> <span class="no">JSONAPI</span><span class="o">::</span><span class="no">Hanami</span><span class="o">::</span><span class="no">Action</span>
<span class="n">expose</span> <span class="ss">:url_helpers</span>
<span class="k">def</span> <span class="nf">call</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
<span class="c1"># ...</span>
<span class="vi">@url_helpers</span> <span class="o">=</span> <span class="n">routes</span> <span class="c1"># Will be available inside serializable resources.</span>
<span class="nb">self</span><span class="p">.</span><span class="nf">data</span> <span class="o">=</span> <span class="n">posts</span>
<span class="nb">self</span><span class="p">.</span><span class="nf">include</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:author</span><span class="p">,</span> <span class="ss">comments: </span><span class="p">[</span><span class="ss">:author</span><span class="p">]]</span>
<span class="nb">self</span><span class="p">.</span><span class="nf">fields</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">users: </span><span class="p">[</span><span class="ss">:name</span><span class="p">,</span> <span class="ss">:email</span><span class="p">],</span>
<span class="ss">posts: </span><span class="p">[</span><span class="ss">:title</span><span class="p">,</span> <span class="ss">:content</span><span class="p">]</span> <span class="p">}</span>
<span class="k">end</span>
<span class="k">end</span>
<span class="k">end</span>
</code></pre></div>
<p>For a comprehensive list of renderer options, see <a href="#renderer_options">Renderer options</a>.</p>
<h2 id="renderer_options">Renderer options</h2>
<p>The available options are:</p>
<ul>
<li>data-related options:
<ul>
<li><code>include</code>: the related resources to include in the document. This option can
be specified as a string (e.g. <code>"author,comments.author"</code>), or as an array/
hash of symbols (e.g. <code>[:author, comments: [:author]]</code>).</li>
<li><code>fields</code>: a restricted set of fields for some or all resources. This option
can be specified as a hash of arrays of symbols (e.g.
<code>{ users: [:name, :email], posts: [:title, :content] }</code>).</li>
<li><code>expose</code>: a hash of arbitrary variables that will be made available to the
serializable resources as instance variables.</li>
</ul></li>
<li>serializable resource class related options:
<ul>
<li><code>inferrer</code>: a hash globally mapping model class names to serializable resource
class names.</li>
<li><code>namespace</code>: the namespace in which to look for serializable resource
classes. This option can be specified as a constant (e.g. <code>V2</code>), or as a
string (e.g. <code>"V2"</code>).</li>
<li><code>class</code>: the serializable resource class(es) to be used for the primary
data. This option can be specified as a constant (e.g. <code>SerializablePost</code>),
as a string (e.g. <code>"SerializablePost"</code>), or as a hash (e.g.
<code>{ Article: "SerializableFormattedArticle", Letter: "SerializableFormattedLetter" }</code>).</li>
</ul></li>
<li>top level properties:
<ul>
<li><code>links</code>: a set of top level links. This option can be specified as a hash.</li>
<li><code>meta</code>: top level meta information. This option can be specified as a hash.</li>
<li><code>jsonapi</code>: top level <code>jsonapi</code> object. This option can be specified as a
hash.</li>
</ul></li>
<li>framework-specific options: in Hanami and Rails, the usual options such as
<code>status</code> are respected.</li>
</ul>
</div>
<div class="footer">
<div class="container">
<div class="row">
<div class="col-sm-3 m-b">
<ul class="list-unstyled list-spaced">
<li><h6 class="text-uppercase">Project</h6></li>
<li><a href="https://github.com/jsonapi-rb" target="_blank">GitHub</a></li>
<li><a href="http://twitter.com/jsonapirb" target="_blank">Twitter</a></li>
<li><a href="https://rubygems.org/gems/jsonapi-rb" target="_blank">Rubygems</a></li>
</ul>
</div>
<div class="col-sm-3 m-b">
<ul class="list-unstyled list-spaced">
<li><h6 class="text-uppercase">Community</h6></li>
<li><a href="https://gitter.im/jsonapi-rb" target="_blank">Chat</a></li>
<li><a href="https://stackoverflow.com/questions/tagged/jsonapi-rb" target="_blank">StackOverflow</a></li>
</ul>
</div>
<div class="col-sm-6">
<h6 class="text-uppercase">About</h6>
<p>
jsonapi-rb is a <a href="http://jsonapi.org">JSON API</a> library for
ruby — © 2016-2017
<a href="http://lucashosseini.com" target="_blank">Lucas Hosseini</a>.<br>
Released under the <a href="https://opensource.org/licenses/MIT" target="_blank">MIT License</a>.
</p>
</div>
</div>
</div>
</div>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-87685934-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>