graphiti 2.0.0.beta.7 → 2.0.0.beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (238) hide show
  1. checksums.yaml +4 -4
  2. data/.git-blame-ignore-revs +2 -0
  3. data/.github/workflows/ci.yml +55 -3
  4. data/.github/workflows/docs.yml +1 -1
  5. data/.github/workflows/notify-example-app.yml +18 -0
  6. data/.gitignore +2 -0
  7. data/.standard.yml +6 -0
  8. data/CHANGELOG.md +45 -0
  9. data/CONTRIBUTING.md +3 -1
  10. data/README.md +13 -206
  11. data/Rakefile +6 -3
  12. data/UPGRADING.md +1 -1
  13. data/graphiti.gemspec +8 -4
  14. data/lib/generators/graphiti/generator_mixin.rb +1 -1
  15. data/lib/generators/graphiti/install_generator.rb +1 -1
  16. data/lib/generators/graphiti/resource_generator.rb +6 -3
  17. data/lib/generators/graphiti/templates/application_resource.rb.erb +19 -0
  18. data/lib/generators/graphiti/templates/controller.rb.erb +26 -8
  19. data/lib/graphiti/audit/report.rb +6 -6
  20. data/lib/graphiti/audit.rb +3 -4
  21. data/lib/graphiti/delegates/pagination.rb +2 -2
  22. data/lib/graphiti/deserializer.rb +3 -3
  23. data/lib/graphiti/errors.rb +6 -6
  24. data/lib/graphiti/extensions/temp_id.rb +1 -1
  25. data/lib/graphiti/query.rb +3 -3
  26. data/lib/graphiti/rails/context.rb +2 -1
  27. data/lib/graphiti/rails/controller.rb +3 -0
  28. data/lib/graphiti/rails/debugging.rb +1 -1
  29. data/lib/graphiti/rails/responders.rb +2 -1
  30. data/lib/graphiti/resource/configuration.rb +1 -0
  31. data/lib/graphiti/resource/dsl.rb +2 -2
  32. data/lib/graphiti/resource/links.rb +1 -1
  33. data/lib/graphiti/resource/persistence.rb +1 -1
  34. data/lib/graphiti/resource/polymorphism.rb +1 -1
  35. data/lib/graphiti/resource.rb +2 -2
  36. data/lib/graphiti/resource_proxy.rb +0 -1
  37. data/lib/graphiti/scoping/filter.rb +5 -3
  38. data/lib/graphiti/scoping/paginate.rb +1 -1
  39. data/lib/graphiti/scoping/sort.rb +1 -1
  40. data/lib/graphiti/sideload/has_many.rb +1 -1
  41. data/lib/graphiti/spec_helpers/errors_proxy.rb +1 -1
  42. data/lib/graphiti/spec_helpers/matchers.rb +1 -1
  43. data/lib/graphiti/types.rb +5 -1
  44. data/lib/graphiti/util/cache_debug.rb +3 -3
  45. data/lib/graphiti/util/hash.rb +1 -1
  46. data/lib/graphiti/util/persistence.rb +6 -6
  47. data/lib/graphiti/util/serializer_relationships.rb +1 -1
  48. data/lib/graphiti/version.rb +1 -1
  49. data/lib/tasks/graphiti.rake +1 -1
  50. metadata +31 -197
  51. data/docs/concepts/backends-and-models.md +0 -122
  52. data/docs/concepts/endpoints.md +0 -183
  53. data/docs/concepts/links.md +0 -212
  54. data/docs/concepts/overview.md +0 -80
  55. data/docs/concepts/persisting.md +0 -376
  56. data/docs/concepts/relationships.md +0 -627
  57. data/docs/concepts/resources.md +0 -677
  58. data/docs/getting-started/first-api.md +0 -289
  59. data/docs/getting-started/installation.md +0 -185
  60. data/docs/intro.md +0 -307
  61. data/docs/js/authentication.md +0 -63
  62. data/docs/js/ddau.md +0 -20
  63. data/docs/js/extra-params.md +0 -41
  64. data/docs/js/index.md +0 -112
  65. data/docs/js/installation.md +0 -120
  66. data/docs/js/middleware.md +0 -72
  67. data/docs/js/models.md +0 -202
  68. data/docs/js/reads.md +0 -494
  69. data/docs/js/state-syncing.md +0 -100
  70. data/docs/js/writes.md +0 -373
  71. data/docs/reference/vandal.md +0 -63
  72. data/docs/reference/why.md +0 -13
  73. data/docs/topics/authorization.md +0 -155
  74. data/docs/topics/caching.md +0 -55
  75. data/docs/topics/customizing-sideloads.md +0 -156
  76. data/docs/topics/debugging.md +0 -242
  77. data/docs/topics/error-handling.md +0 -210
  78. data/docs/topics/etags.md +0 -46
  79. data/docs/topics/hopping-relationships.md +0 -149
  80. data/docs/topics/json-attributes.md +0 -77
  81. data/docs/topics/openstruct-models.md +0 -50
  82. data/docs/topics/remote-resources.md +0 -291
  83. data/docs/topics/testing.md +0 -916
  84. data/docs/topics/without-activerecord.md +0 -324
  85. data/docs/tutorial/index.md +0 -58
  86. data/docs/tutorial/step_0.md +0 -107
  87. data/docs/tutorial/step_1.md +0 -199
  88. data/docs/tutorial/step_2.md +0 -312
  89. data/docs/tutorial/step_3.md +0 -142
  90. data/docs/tutorial/step_4.md +0 -135
  91. data/docs/tutorial/step_5.md +0 -69
  92. data/docs/tutorial/step_6.md +0 -82
  93. data/docs/tutorial/step_7.md +0 -205
  94. data/docs/tutorial/step_8.md +0 -128
  95. data/docs/tutorial/step_9.md +0 -171
  96. data/docs/upgrading.md +0 -267
  97. data/website/.gitignore +0 -20
  98. data/website/README.md +0 -43
  99. data/website/docusaurus.config.js +0 -197
  100. data/website/package-lock.json +0 -19474
  101. data/website/package.json +0 -46
  102. data/website/sidebars.js +0 -82
  103. data/website/src/css/custom.css +0 -85
  104. data/website/src/pages/markdown-page.mdx +0 -7
  105. data/website/static/.nojekyll +0 -0
  106. data/website/static/1.13/2019/03/31/graphiti-1-0.html +0 -205
  107. data/website/static/1.13/2019/05/08/graphiti-1-1.html +0 -212
  108. data/website/static/1.13/2019/05/20/graphiti-1-2.html +0 -214
  109. data/website/static/1.13/2019/10/14/tutorial.html +0 -198
  110. data/website/static/1.13/CNAME +0 -1
  111. data/website/static/1.13/README.md +0 -16
  112. data/website/static/1.13/assets/css/syntax.css +0 -60
  113. data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
  114. data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
  115. data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
  116. data/website/static/1.13/assets/favicons/browserconfig.xml +0 -9
  117. data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
  118. data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
  119. data/website/static/1.13/assets/favicons/favicon.ico +0 -0
  120. data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
  121. data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +0 -1
  122. data/website/static/1.13/assets/favicons/site.webmanifest +0 -19
  123. data/website/static/1.13/assets/img/backend.gif +0 -0
  124. data/website/static/1.13/assets/img/conformity.png +0 -0
  125. data/website/static/1.13/assets/img/error_payload.png +0 -0
  126. data/website/static/1.13/assets/img/fancy-cushion.png +0 -0
  127. data/website/static/1.13/assets/img/gh.png +0 -0
  128. data/website/static/1.13/assets/img/home-bg.jpg +0 -0
  129. data/website/static/1.13/assets/img/lifecycle.gif +0 -0
  130. data/website/static/1.13/assets/img/logo-500.png +0 -0
  131. data/website/static/1.13/assets/img/logo.png +0 -0
  132. data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
  133. data/website/static/1.13/assets/img/meta_total_count.png +0 -0
  134. data/website/static/1.13/assets/img/persist.jpg +0 -0
  135. data/website/static/1.13/assets/img/resource.gif +0 -0
  136. data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
  137. data/website/static/1.13/assets/img/rest1.gif +0 -0
  138. data/website/static/1.13/assets/img/rest2.gif +0 -0
  139. data/website/static/1.13/assets/img/rest3.gif +0 -0
  140. data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
  141. data/website/static/1.13/assets/img/sunrise.png +0 -0
  142. data/website/static/1.13/assets/img/why.png +0 -0
  143. data/website/static/1.13/assets/js/highlight.pack.js +0 -2
  144. data/website/static/1.13/assets/main.css +0 -15518
  145. data/website/static/1.13/assets/main.css.map +0 -1
  146. data/website/static/1.13/bin/bundle +0 -109
  147. data/website/static/1.13/bin/jekyll +0 -27
  148. data/website/static/1.13/bin/kramdown +0 -27
  149. data/website/static/1.13/bin/listen +0 -27
  150. data/website/static/1.13/bin/rake +0 -27
  151. data/website/static/1.13/bin/rougify +0 -27
  152. data/website/static/1.13/bin/safe_yaml +0 -27
  153. data/website/static/1.13/bin/sass +0 -27
  154. data/website/static/1.13/bin/sass-convert +0 -27
  155. data/website/static/1.13/bin/scss +0 -27
  156. data/website/static/1.13/blog.html +0 -259
  157. data/website/static/1.13/cheatsheet.html +0 -316
  158. data/website/static/1.13/cookbooks/authorization.md +0 -0
  159. data/website/static/1.13/cookbooks/caching.md +0 -0
  160. data/website/static/1.13/cookbooks/customizing-sideloads.html +0 -325
  161. data/website/static/1.13/cookbooks/etags.md +0 -0
  162. data/website/static/1.13/cookbooks/hopping-relationships.html +0 -324
  163. data/website/static/1.13/cookbooks/json_attributes.md +0 -0
  164. data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
  165. data/website/static/1.13/cookbooks/remote-resources.md +0 -0
  166. data/website/static/1.13/cookbooks/without-activerecord.html +0 -510
  167. data/website/static/1.13/features.html +0 -249
  168. data/website/static/1.13/feed.xml +0 -106
  169. data/website/static/1.13/guides/concepts/backends-and-models.html +0 -467
  170. data/website/static/1.13/guides/concepts/debugging.html +0 -440
  171. data/website/static/1.13/guides/concepts/endpoints.html +0 -432
  172. data/website/static/1.13/guides/concepts/error-handling.html +0 -396
  173. data/website/static/1.13/guides/concepts/links.html +0 -501
  174. data/website/static/1.13/guides/concepts/remote-resources.html +0 -536
  175. data/website/static/1.13/guides/concepts/resources.html +0 -2176
  176. data/website/static/1.13/guides/concepts/testing.html +0 -1469
  177. data/website/static/1.13/guides/getting-started/installation.html +0 -420
  178. data/website/static/1.13/guides/graphiti-rails-migration.html +0 -242
  179. data/website/static/1.13/guides/index.html +0 -269
  180. data/website/static/1.13/guides/overview.html +0 -325
  181. data/website/static/1.13/guides/upgrading-2-0.html +0 -193
  182. data/website/static/1.13/guides/upgrading.html +0 -314
  183. data/website/static/1.13/guides/vandal.html +0 -282
  184. data/website/static/1.13/guides/why.html +0 -1121
  185. data/website/static/1.13/index.html +0 -72
  186. data/website/static/1.13/js/authentication.html +0 -295
  187. data/website/static/1.13/js/ddau.html +0 -238
  188. data/website/static/1.13/js/extra-params.html +0 -270
  189. data/website/static/1.13/js/index.html +0 -321
  190. data/website/static/1.13/js/installation.html +0 -637
  191. data/website/static/1.13/js/introduction.html +0 -257
  192. data/website/static/1.13/js/middleware.html +0 -318
  193. data/website/static/1.13/js/reads/fieldsets.html +0 -271
  194. data/website/static/1.13/js/reads/filtering.html +0 -289
  195. data/website/static/1.13/js/reads/includes.html +0 -260
  196. data/website/static/1.13/js/reads/index.html +0 -497
  197. data/website/static/1.13/js/reads/nested-queries.html +0 -353
  198. data/website/static/1.13/js/reads/pagination.html +0 -260
  199. data/website/static/1.13/js/reads/sorting.html +0 -265
  200. data/website/static/1.13/js/reads/statistics.html +0 -289
  201. data/website/static/1.13/js/state-syncing.html +0 -340
  202. data/website/static/1.13/js/writes/deferred.html +0 -296
  203. data/website/static/1.13/js/writes/dirty-tracking.html +0 -399
  204. data/website/static/1.13/js/writes/index.html +0 -391
  205. data/website/static/1.13/js/writes/nested.html +0 -330
  206. data/website/static/1.13/js/writes/validations.html +0 -272
  207. data/website/static/1.13/quickstart.html +0 -660
  208. data/website/static/1.13/template +0 -161
  209. data/website/static/1.13/tutorial/index.html +0 -250
  210. data/website/static/1.13/tutorial/step_0.html +0 -292
  211. data/website/static/1.13/tutorial/step_1.html +0 -517
  212. data/website/static/1.13/tutorial/step_2.html +0 -481
  213. data/website/static/1.13/tutorial/step_3.html +0 -323
  214. data/website/static/1.13/tutorial/step_4.html +0 -318
  215. data/website/static/1.13/tutorial/step_5.html +0 -265
  216. data/website/static/1.13/tutorial/step_6.html +0 -276
  217. data/website/static/1.13/tutorial/step_7.html +0 -390
  218. data/website/static/1.13/tutorial/step_8.html +0 -316
  219. data/website/static/1.13/tutorial/step_9.html +0 -365
  220. data/website/static/CNAME +0 -1
  221. data/website/static/assets/img/error_payload.png +0 -0
  222. data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
  223. data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
  224. data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
  225. data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
  226. data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
  227. data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
  228. data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
  229. data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
  230. data/website/static/assets/img/meta_total_count.png +0 -0
  231. data/website/static/img/docusaurus-social-card.jpg +0 -0
  232. data/website/static/img/docusaurus.png +0 -0
  233. data/website/static/img/favicon.ico +0 -0
  234. data/website/static/img/logo.png +0 -0
  235. data/website/static/img/logo.svg +0 -1
  236. data/website/static/img/undraw_docusaurus_mountain.svg +0 -171
  237. data/website/static/img/undraw_docusaurus_react.svg +0 -170
  238. data/website/static/img/undraw_docusaurus_tree.svg +0 -40
data/website/static/1.13/tutorial/step_0.html DELETED
@@ -1,292 +0,0 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
-
4
- <head>
5
- <meta charset="utf-8">
6
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
7
- <meta name="viewport" content="width=device-width, initial-scale=1">
8
- <link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
9
- <link href="https://fonts.googleapis.com/css?family=Boogaloo" rel="stylesheet">
10
-
11
- <link rel="apple-touch-icon" sizes="180x180" href="/1.13/assets/favicons/apple-touch-icon.png">
12
- <link rel="icon" type="image/png" sizes="32x32" href="/1.13/assets/favicons/favicon-32x32.png">
13
- <link rel="icon" type="image/png" sizes="16x16" href="/1.13/assets/favicons/favicon-16x16.png">
14
- <link rel="manifest" href="/1.13/assets/favicons/site.webmanifest">
15
- <link rel="mask-icon" href="/1.13/assets/favicons/safari-pinned-tab.svg" color="#F86DA7">
16
- <link rel="shortcut icon" href="/1.13/assets/favicons/favicon.ico">
17
- <meta name="msapplication-TileColor" content="#F86DA7">
18
- <meta name="msapplication-config" content="/1.13/assets/favicons/browserconfig.xml">
19
- <meta name="theme-color" content="#F86DA7">
20
-
21
- <title>Graphiti</title>
22
- <meta name="description" content="Stylish Graph APIs">
23
-
24
- <link rel="stylesheet" href="/1.13/assets/main.css?ref=wh4t3v45">
25
- <link rel="alternate" type="application/rss+xml" title="Graphiti" href="/1.13/feed.xml">
26
-
27
- <!-- Global site tag (gtag.js) - Google Analytics -->
28
- <script async src="https://www.googletagmanager.com/gtag/js?id=UA-127904727-1"></script>
29
- <script>
30
- window.dataLayer = window.dataLayer || [];
31
- function gtag(){dataLayer.push(arguments);}
32
- gtag('js', new Date());
33
-
34
- gtag('config', 'UA-127904727-1');
35
- </script>
36
-
37
- <!-- javascript -->
38
- <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
39
- <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js" integrity="sha384-Tc5IQib027qvyjSMfHjOMaLkfuWVxZxUPnCJA7l2mCWNIpG9mGCD8wGNIcPD7Txa" crossorigin="anonymous"></script>
40
-
41
-
42
- </head>
43
-
44
-
45
- <body>
46
- <main class="page-content" aria-label="Content">
47
- <div class="wrapper">
48
- <header class="navbar navbar-inverse normal" role="banner">
49
- <div class="container">
50
- <div class="navbar-header">
51
- <a href="/1.13/1.13" class="navbar-brand">
52
- <img alt="logo" src="/1.13/assets/img/logo.png">
53
- </a>
54
- </div>
55
- <nav class="" role="navigation">
56
- <ul class="nav navbar-nav nav-links">
57
- <li>
58
- <a class="quickstart nav-link" href="/1.13/quickstart">Quickstart</a>
59
- </li>
60
- <li>
61
- <a class="guides nav-link" href="/1.13/guides">Guides</a>
62
- </li>
63
- <li>
64
- <a class="tutorial nav-link" href="/1.13/tutorial">Tutorial</a>
65
- </li>
66
- <li>
67
- <a class="spraypaint nav-link" href="/1.13/js">Spraypaint</a>
68
- </li>
69
- </ul>
70
- <ul class="nav gh navbar-nav navbar-right visible-lg visible-md">
71
- <li>
72
- <span class="star">⭐</span>
73
- <a href="https://github.com/graphiti-api/graphiti">
74
- <img alt="github-star" style="margin-right: 65px;margin-top: -20px" src="/1.13/assets/img/gh.png">
75
- </a>
76
- </li>
77
- </ul>
78
- </nav>
79
- </div>
80
- </header>
81
-
82
- <div class="container">
83
- <div class="toc col-md-3">
84
- <h1 id="tutorial">Tutorial</h1>
85
-
86
- <ul>
87
- <li><a href="/1.13/tutorial/step_0">Step 0: Bootstrapping</a></li>
88
- <li><a href="/1.13/tutorial/step_1">Step 1: Initial Resource</a></li>
89
- <li><a href="/1.13/tutorial/step_2">Step 2: Has Many</a></li>
90
- <li><a href="/1.13/tutorial/step_3">Step 3: Belongs To</a></li>
91
- <li><a href="/1.13/tutorial/step_4">Step 4: Customizing Queries</a></li>
92
- <li><a href="/1.13/tutorial/step_5">Step 5: Has One</a></li>
93
- <li><a href="/1.13/tutorial/step_6">Step 6: Customizing Writes</a></li>
94
- <li><a href="/1.13/tutorial/step_7">Step 7: Many-to-Many</a></li>
95
- <li><a href="/1.13/tutorial/step_8">Step 8: Polymorphic Relationships</a></li>
96
- <li><a href="/1.13/tutorial/step_9">Step 9: Polymorphic Resources</a></li>
97
- </ul>
98
- </div>
99
-
100
- <div class="col-md-8">
101
-
102
- <h2 id="step-0-bootstrapping">Step 0: Bootstrapping</h2>
103
-
104
- <blockquote>
105
- <p><a href="https://github.com/graphiti-api/employee_directory/commit/e2552ce212c68b41a3eb8161deb822fff3e159d6">View the Code</a></p>
106
- </blockquote>
107
-
108
- <p>Let’s start by creating a new Rails project. For help with an existing
109
- project, check out <a href="/1.13/guides/getting-started/installation">Installation: From
110
- Scratch</a>.</p>
111
-
112
- <p>We’ll use the <code class="language-plaintext highlighter-rouge">-m</code> option to install from a template, which will add a few gems and apply some setup boilerplate. Accept all the default options.</p>
113
-
114
- <figure class="highlight"><pre><code class="language-bash" data-lang="bash"><span class="nv">$ </span>rails new employee_directory <span class="nt">--api</span> <span class="nt">-m</span> /1.13/template
115
- <span class="nv">$ </span><span class="nb">cd </span>employee_directory</code></pre></figure>
116
-
117
- <blockquote>
118
- <p>Note: if a network issue prevents you from pointing to this URL directly, you can download the file and and run this command as <code class="language-plaintext highlighter-rouge">-m /path/to/template</code></p>
119
- </blockquote>
120
-
121
- <p>Feel free to run <code class="language-plaintext highlighter-rouge">git diff</code> to see what the generator did, otherwise commit the result. You can now head to <a href="/1.13/tutorial/step_1">Step 1: Basic Resource</a>, or continue reading to better understand the code.</p>
122
-
123
- <h4 id="digging-deeper-">Digging Deeper 🧐</h4>
124
-
125
- <p>You’ll see some boilerplate in <code class="language-plaintext highlighter-rouge">config/routes.rb</code>:</p>
126
-
127
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">scope</span> <span class="ss">path: </span><span class="no">ApplicationResource</span><span class="p">.</span><span class="nf">endpoint_namespace</span><span class="p">,</span> <span class="ss">defaults: </span><span class="p">{</span> <span class="ss">format: :jsonapi</span> <span class="p">}</span> <span class="k">do</span>
128
- <span class="c1"># your routes go here</span>
129
- <span class="k">end</span></code></pre></figure>
130
-
131
- <p>This tells Rails that our API routes will be be prefixed - <code class="language-plaintext highlighter-rouge">/api/v1</code> by default. It also
132
- says that if no extension is in the URL (<code class="language-plaintext highlighter-rouge">.json</code>, <code class="language-plaintext highlighter-rouge">.xml</code>, etc), default
133
- to the <a href="http://jsonapi.org">JSONAPI Specification</a>.</p>
134
-
135
- <p>Let’s look at the above <code class="language-plaintext highlighter-rouge">ApplicationResource</code>:</p>
136
-
137
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o">&lt;</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
138
- <span class="nb">self</span><span class="p">.</span><span class="nf">abstract_class</span> <span class="o">=</span> <span class="kp">true</span>
139
-
140
- <span class="c1"># We'll be using ActiveRecord</span>
141
- <span class="nb">self</span><span class="p">.</span><span class="nf">adapter</span> <span class="o">=</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Adapters</span><span class="o">::</span><span class="no">ActiveRecord</span>
142
-
143
- <span class="c1"># Links are generated from base_url + endpoint_namespace</span>
144
- <span class="nb">self</span><span class="p">.</span><span class="nf">base_url</span> <span class="o">=</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">application</span><span class="p">.</span><span class="nf">routes</span>
145
- <span class="p">.</span><span class="nf">default_url_options</span><span class="p">[</span><span class="ss">:host</span><span class="p">]</span>
146
- <span class="nb">self</span><span class="p">.</span><span class="nf">endpoint_namespace</span> <span class="o">=</span> <span class="s1">'/api/v1'</span>
147
- <span class="k">end</span></code></pre></figure>
148
-
149
- <p>This should be pretty self-explanatory except for</p>
150
-
151
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="nb">self</span><span class="p">.</span><span class="nf">base_url</span> <span class="o">=</span> <span class="no">Rails</span><span class="p">.</span><span class="nf">application</span><span class="p">.</span><span class="nf">routes</span>
152
- <span class="p">.</span><span class="nf">default_url_options</span><span class="p">[</span><span class="ss">:host</span><span class="p">]</span></code></pre></figure>
153
-
154
- <p>This is configured in <code class="language-plaintext highlighter-rouge">config/application.rb</code>:</p>
155
-
156
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">module</span> <span class="nn">EmployeeDirectory</span>
157
- <span class="k">class</span> <span class="nc">Application</span> <span class="o">&lt;</span> <span class="no">Rails</span><span class="o">::</span><span class="no">Application</span>
158
- <span class="n">routes</span><span class="p">.</span><span class="nf">default_url_options</span><span class="p">[</span><span class="ss">:host</span><span class="p">]</span> <span class="o">=</span> <span class="no">ENV</span><span class="p">.</span><span class="nf">fetch</span><span class="p">(</span><span class="s1">'HOST'</span><span class="p">,</span> <span class="s1">'http://localhost:3000'</span><span class="p">)</span>
159
- <span class="c1"># ... code ...</span>
160
- <span class="k">end</span>
161
- <span class="k">end</span></code></pre></figure>
162
-
163
- <p>When deriving and validating <a href="/1.13/guides/links">Links</a>, we’ll use the <code class="language-plaintext highlighter-rouge">HOST</code> variable if
164
- present, falling back to the Rails development default of
165
- <code class="language-plaintext highlighter-rouge">http://localhost:3000</code>. This means our Links will look like:</p>
166
-
167
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="s2">"</span><span class="si">#{</span><span class="no">ENV</span><span class="p">[</span><span class="s1">'HOST'</span><span class="p">]</span><span class="si">}</span><span class="s2">/</span><span class="si">#{</span><span class="no">ApplicationRecord</span><span class="p">.</span><span class="nf">endpoint_namespace</span><span class="si">}</span><span class="s2">/</span><span class="si">#{</span><span class="no">Resource</span><span class="p">.</span><span class="nf">type</span><span class="si">}</span><span class="s2">"</span></code></pre></figure>
168
-
169
- <p>For example:</p>
170
-
171
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">http</span><span class="ss">:/</span><span class="o">/</span><span class="n">my</span><span class="o">-</span><span class="n">website</span><span class="p">.</span><span class="nf">com</span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="n">v1</span><span class="o">/</span><span class="n">employees</span></code></pre></figure>
172
-
173
- <p>Read more in the <a href="/1.13/guides/links">Links Guide</a>.</p>
174
-
175
- <p>Finally, there’s some boilerplate in <code class="language-plaintext highlighter-rouge">ApplicationController</code>:</p>
176
-
177
- <figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationController</span> <span class="o">&lt;</span> <span class="no">ActionController</span><span class="o">::</span><span class="no">API</span>
178
- <span class="c1"># Support JSON, XML, JSON:API</span>
179
- <span class="kp">include</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Rails</span><span class="o">::</span><span class="no">Responders</span>
180
- <span class="k">end</span></code></pre></figure>
181
-
182
- <p>This gets <code class="language-plaintext highlighter-rouge">respond_with</code> working, via the <a href="https://github.com/plataformatec/responders">Responders gem</a>. To render simple nested JSON like default Rails, we’ll only need to add <code class="language-plaintext highlighter-rouge">.json</code> to the URL.</p>
183
-
184
- <p>That’s it for basic setup!</p>
185
-
186
- </div>
187
-
188
- <div class="clearfix">
189
- <h2 id="next">
190
- <a href="/1.13/tutorial/step_1">
191
- NEXT -
192
- <small>Step 1: Basic Resource</small>
193
- &raquo;
194
- </a>
195
- </h2>
196
- </div>
197
-
198
- </div>
199
- </div>
200
- </main>
201
- <div class="main-footer main-footer--dark">
202
- <div class="container">
203
- <div class="row">
204
- <div class="col-sm-4 menu">
205
- <h3>Overview</h3>
206
- <ul>
207
- <li>
208
- <a href="/1.13/quickstart">Quickstart</a>
209
- </li>
210
- <li>
211
- <a href="/1.13/tutorial">Tutorial</a>
212
- </li>
213
- <li>
214
- <a href="/1.13/guides">Guides</a>
215
- </li>
216
- </ul>
217
- </div>
218
- <div class="col-sm-4 menu">
219
- <h3>Contact</h3>
220
- <ul>
221
- <li>
222
- <a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
223
- </li>
224
- <li>
225
- <a href="mailto:richmolj@gmail.com">Email</a>
226
- </li>
227
- </ul>
228
- </div>
229
- <div class="col-sm-4 menu">
230
- <h3>Related</h3>
231
- <ul>
232
- <li>
233
- <a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
234
- </li>
235
- <li>
236
- <a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
237
- </li>
238
- <li>
239
- <a target="_blank" href="https://vuejs.org/">VueJS</a>
240
- </li>
241
- </ul>
242
- </div>
243
- </div>
244
- </div>
245
- </div>
246
-
247
- <script type="text/javascript">
248
- $(function () {
249
-
250
- var flipTabs = function() {
251
- var isTS = true;
252
- if (localStorage.getItem('js-lang') === 'javascript') {
253
- isTS = false;
254
- }
255
-
256
- $('.code-tabs').each(function(index, el) {
257
- if (isTS) {
258
- console.log('hiding js');
259
- $($(el).children()[1]).hide();
260
- $($(el).children()[0]).show();
261
- } else {
262
- console.log('hiding ts');
263
- $($(el).children()[0]).hide();
264
- $($(el).children()[1]).show();
265
- }
266
- });
267
-
268
- if (isTS) {
269
- $('.tab.typescript').addClass('active');
270
- $('.tab.javascript').removeClass('active');
271
- } else {
272
- $('.tab.typescript').removeClass('active');
273
- $('.tab.javascript').addClass('active');
274
- }
275
- }
276
-
277
- $('.tab').click(function() {
278
- if ($(this).hasClass('typescript')) {
279
- localStorage.setItem('js-lang', 'typescript');
280
- } else {
281
- localStorage.setItem('js-lang', 'javascript');
282
- }
283
-
284
- flipTabs();
285
- });
286
-
287
- flipTabs();
288
- })
289
- </script>
290
-
291
- </body>
292
- </html>