-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfile.SHARE.html
196 lines (144 loc) · 6.02 KB
/
file.SHARE.html
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
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
File: SHARE
— Documentation by YARD 0.9.25
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "SHARE";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="file_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index</a> »
<span class="title">File: SHARE</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><div id='filecontents'><h1 id="sharing-fields">Sharing fields</h1>
<h1 id="introduction">Introduction</h1>
<p>Often, you will have a similar set of fields returned or used by multiple endpoints.</p>
<p>Flappi has no specific mechanism to share fields, but you can easily do this using regular Ruby.</p>
<h1 id="example">Example</h1>
<p>In <a href="file.NEST.html">Nesting structures in a response</a> we worked with a <code>Cheese</code> type.
We now add a similar <code>Chocolate</code> type, which also has <code>package</code> and <code>name</code> fields:</p>
<pre class="code ruby"><code class="ruby"><span class='lbrace'>{</span>
<span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Milky Way</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
<span class='label'>milk:</span> <span class='kw'>true</span><span class='comma'>,</span>
<span class='label'>cocoa_percent:</span> <span class='int'>10</span><span class='comma'>,</span>
<span class='label'>package:</span> <span class='lbrace'>{</span> <span class='label'>weight_grams:</span> <span class='int'>100</span><span class='comma'>,</span> <span class='label'>price:</span> <span class='float'>2.20</span> <span class='rbrace'>}</span>
<span class='rbrace'>}</span>
</code></pre>
<p>To save repeating ourselves, we can modify the <code>Cheese</code> definition to extract the shared fields:</p>
<pre class="code ruby"><code class="ruby">module ApiDefinitions
module Cheeses
include Flappi::Definition
include CommonApi
def endpoint
title 'List available cheeses'
...
end
# Build a record with each result from the table
# This will call Cheese.where()
def respond
build type: Cheese do
objects :cheeses, doc: 'List of cheeses' do
field :soft, type: BOOLEAN
field :cheese_type
common_fields
end
end
end
end
end
</code></pre>
<p>and create a module and method for the shared fields</p>
<pre class="code ruby"><code class="ruby"><span class='kw'>module</span> <span class='const'>CommonApi</span>
<span class='kw'>def</span> <span class='id identifier rubyid_common_fields'>common_fields</span>
<span class='id identifier rubyid_field'>field</span> <span class='symbol'>:name</span>
<span class='id identifier rubyid_object'>object</span> <span class='label'>name:</span> <span class='id identifier rubyid_package'>package</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>Package</span> <span class='kw'>do</span>
<span class='id identifier rubyid_field'>field</span> <span class='symbol'>:weight</span><span class='comma'>,</span> <span class='label'>source:</span> <span class='symbol'>:weight_grams</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>Integer</span>
<span class='id identifier rubyid_field'>field</span> <span class='symbol'>:price</span><span class='comma'>,</span> <span class='label'>type:</span> <span class='const'>BigDecimal</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
</code></pre>
<p>Note that we don't generally need to pass values into the shared method.</p>
<p>We can now use this to implement <code>Chocolates</code>:</p>
<pre class="code ruby"><code class="ruby">module ApiDefinitions
module Chocolates
include Flappi::Definition
include CommonApi
def endpoint
title 'List available chocolates'
...
end
def respond
build type: Cheese do
objects :chocolates, doc: 'List of chocolates' do
field :milk, type: BOOLEAN
field :cocoa_percent, type: Float
common_fields
end
end
end
end
end
</code></pre>
<h1 id="sharing-parameters">Sharing parameters</h1>
<p>We can share parameters in the same way as fields:</p>
<pre class="code ruby"><code class="ruby">module CommonApi
def common_params
param :name, doc: 'The name of the product'
end
...
end
</code></pre>
<p>and use this as:</p>
<pre class="code ruby"><code class="ruby">module ApiDefinitions
module CheesesCreate
include Flappi::Definition
include CommonApi
def endpoint
title 'Create a cheese'
...
common_params
end
...
end
end
</code></pre>
<p>and similarly to make an endpoint to create chocolates.</p>
</div></div>
<div id="footer">
Generated on Tue Dec 1 14:56:46 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
</div>
</body>
</html>