graphiti 2.0.0.beta.2 → 2.0.0.beta.4
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.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +30 -86
- data/.github/workflows/docs.yml +60 -0
- data/.github/workflows/release.yml +8 -8
- data/.gitignore +7 -0
- data/.npmrc +9 -0
- data/.standard.yml +4 -1
- data/Appraisals +33 -32
- data/CHANGELOG.md +41 -0
- data/README.md +13 -2
- data/UPGRADING.md +2 -68
- data/docs/concepts/backends-and-models.md +122 -0
- data/docs/concepts/endpoints.md +183 -0
- data/docs/concepts/links.md +212 -0
- data/docs/concepts/overview.md +80 -0
- data/docs/concepts/persisting.md +376 -0
- data/docs/concepts/relationships.md +527 -0
- data/docs/concepts/resources.md +677 -0
- data/docs/getting-started/first-api.md +289 -0
- data/docs/getting-started/installation.md +185 -0
- data/docs/intro.md +307 -0
- data/docs/js/authentication.md +63 -0
- data/docs/js/ddau.md +20 -0
- data/docs/js/extra-params.md +41 -0
- data/docs/js/index.md +112 -0
- data/docs/js/installation.md +120 -0
- data/docs/js/middleware.md +72 -0
- data/docs/js/models.md +202 -0
- data/docs/js/reads.md +494 -0
- data/docs/js/state-syncing.md +100 -0
- data/docs/js/writes.md +373 -0
- data/docs/reference/vandal.md +63 -0
- data/docs/reference/why.md +13 -0
- data/docs/topics/authorization.md +155 -0
- data/docs/topics/caching.md +55 -0
- data/docs/topics/customizing-sideloads.md +156 -0
- data/docs/topics/debugging.md +216 -0
- data/docs/topics/error-handling.md +210 -0
- data/docs/topics/etags.md +46 -0
- data/docs/topics/hopping-relationships.md +149 -0
- data/docs/topics/json-attributes.md +77 -0
- data/docs/topics/openstruct-models.md +50 -0
- data/docs/topics/remote-resources.md +291 -0
- data/docs/topics/testing.md +894 -0
- data/docs/topics/without-activerecord.md +324 -0
- data/docs/tutorial/index.md +58 -0
- data/docs/tutorial/step_0.md +107 -0
- data/docs/tutorial/step_1.md +199 -0
- data/docs/tutorial/step_2.md +312 -0
- data/docs/tutorial/step_3.md +142 -0
- data/docs/tutorial/step_4.md +135 -0
- data/docs/tutorial/step_5.md +69 -0
- data/docs/tutorial/step_6.md +82 -0
- data/docs/tutorial/step_7.md +205 -0
- data/docs/tutorial/step_8.md +128 -0
- data/docs/tutorial/step_9.md +171 -0
- data/docs/upgrading.md +265 -0
- data/gemfiles/rails_7_1.gemfile +4 -3
- data/gemfiles/{rails_7_2_graphiti_rails.gemfile → rails_7_2.gemfile} +3 -3
- data/gemfiles/{rails_8_1_graphiti_rails.gemfile → rails_8_0.gemfile} +3 -3
- data/gemfiles/{rails_8_0_graphiti_rails.gemfile → rails_8_1.gemfile} +3 -3
- data/graphiti.gemspec +7 -5
- data/{deprecated_generators → lib/generators}/graphiti/api_test_generator.rb +7 -1
- data/{deprecated_generators → lib/generators}/graphiti/generator_mixin.rb +14 -1
- data/{deprecated_generators → lib/generators}/graphiti/install_generator.rb +19 -13
- data/{deprecated_generators → lib/generators}/graphiti/resource_generator.rb +43 -6
- data/{deprecated_generators → lib/generators}/graphiti/templates/index_request_spec.rb.erb +1 -1
- data/{deprecated_generators → lib/generators}/graphiti/templates/resource_reads_spec.rb.erb +6 -6
- data/{deprecated_generators → lib/generators}/graphiti/templates/show_request_spec.rb.erb +1 -1
- data/lib/graphiti/configuration.rb +2 -2
- data/lib/graphiti/error_serializers/conflict_request.rb +19 -0
- data/lib/graphiti/error_serializers/deprecated_constants.rb +48 -0
- data/lib/graphiti/error_serializers/invalid_request.rb +56 -0
- data/lib/graphiti/error_serializers/validation.rb +143 -0
- data/lib/graphiti/errors.rb +4 -23
- data/lib/graphiti/query.rb +1 -1
- data/lib/graphiti/rails/context.rb +33 -0
- data/lib/graphiti/rails/controller.rb +41 -0
- data/lib/graphiti/rails/debugging.rb +18 -0
- data/lib/graphiti/rails/exception_handlers.rb +77 -0
- data/lib/graphiti/rails/railtie.rb +139 -0
- data/lib/graphiti/rails/responders.rb +21 -0
- data/lib/graphiti/rails/test_helpers.rb +22 -0
- data/lib/graphiti/rails.rb +47 -29
- data/lib/graphiti/resource/configuration.rb +1 -0
- data/lib/graphiti/resource/interface.rb +2 -2
- data/lib/graphiti/resource/persistence.rb +14 -2
- data/lib/graphiti/resource/remote.rb +2 -2
- data/lib/graphiti/resource/sideloading.rb +1 -1
- data/lib/graphiti/resource.rb +13 -1
- data/lib/graphiti/responders.rb +7 -20
- data/lib/graphiti/schema.rb +5 -1
- data/lib/graphiti/schema_diff.rb +4 -0
- data/lib/graphiti/scope.rb +45 -37
- data/lib/graphiti/serializer.rb +6 -0
- data/lib/graphiti/sideload/belongs_to.rb +38 -5
- data/lib/graphiti/sideload/polymorphic_belongs_to.rb +27 -23
- data/lib/graphiti/sideload.rb +54 -35
- data/lib/graphiti/spec_helpers/errors.rb +73 -0
- data/lib/graphiti/spec_helpers/errors_proxy.rb +75 -0
- data/lib/graphiti/spec_helpers/helpers.rb +107 -0
- data/lib/graphiti/spec_helpers/node.rb +88 -0
- data/lib/graphiti/spec_helpers/rspec.rb +147 -0
- data/lib/graphiti/spec_helpers.rb +53 -0
- data/lib/graphiti/util/include_params.rb +2 -2
- data/lib/graphiti/util/persistence.rb +10 -11
- data/lib/graphiti/util/serializer_relationships.rb +41 -5
- data/lib/graphiti/version.rb +1 -1
- data/lib/graphiti-rails.rb +11 -0
- data/lib/graphiti.rb +34 -10
- data/lib/graphiti_errors.rb +11 -0
- data/lib/graphiti_spec_helpers/rspec.rb +3 -0
- data/lib/graphiti_spec_helpers.rb +11 -0
- data/lib/{graphiti/deprecated_tasks.rb → tasks/graphiti.rake} +6 -1
- data/package-lock.json +6199 -0
- data/package.json +5 -4
- data/website/.gitignore +20 -0
- data/website/README.md +43 -0
- data/website/docusaurus.config.js +141 -0
- data/website/package-lock.json +19474 -0
- data/website/package.json +46 -0
- data/website/sidebars.js +82 -0
- data/website/src/css/custom.css +58 -0
- data/website/src/pages/markdown-page.mdx +7 -0
- data/website/static/.nojekyll +0 -0
- data/website/static/1.13/2019/03/31/graphiti-1-0.html +205 -0
- data/website/static/1.13/2019/05/08/graphiti-1-1.html +212 -0
- data/website/static/1.13/2019/05/20/graphiti-1-2.html +214 -0
- data/website/static/1.13/2019/10/14/tutorial.html +198 -0
- data/website/static/1.13/CNAME +1 -0
- data/website/static/1.13/README.md +16 -0
- data/website/static/1.13/assets/css/syntax.css +60 -0
- data/website/static/1.13/assets/favicons/android-chrome-192x192.png +0 -0
- data/website/static/1.13/assets/favicons/android-chrome-256x256.png +0 -0
- data/website/static/1.13/assets/favicons/apple-touch-icon.png +0 -0
- data/website/static/1.13/assets/favicons/browserconfig.xml +9 -0
- data/website/static/1.13/assets/favicons/favicon-16x16.png +0 -0
- data/website/static/1.13/assets/favicons/favicon-32x32.png +0 -0
- data/website/static/1.13/assets/favicons/favicon.ico +0 -0
- data/website/static/1.13/assets/favicons/mstile-150x150.png +0 -0
- data/website/static/1.13/assets/favicons/safari-pinned-tab.svg +1 -0
- data/website/static/1.13/assets/favicons/site.webmanifest +19 -0
- data/website/static/1.13/assets/img/backend.gif +0 -0
- data/website/static/1.13/assets/img/conformity.png +0 -0
- data/website/static/1.13/assets/img/error_payload.png +0 -0
- data/website/static/1.13/assets/img/gh.png +0 -0
- data/website/static/1.13/assets/img/lifecycle.gif +0 -0
- data/website/static/1.13/assets/img/logo-500.png +0 -0
- data/website/static/1.13/assets/img/logo.png +0 -0
- data/website/static/1.13/assets/img/love-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/meta_total_count.png +0 -0
- data/website/static/1.13/assets/img/persist.jpg +0 -0
- data/website/static/1.13/assets/img/resource.gif +0 -0
- data/website/static/1.13/assets/img/rest-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/rest1.gif +0 -0
- data/website/static/1.13/assets/img/rest2.gif +0 -0
- data/website/static/1.13/assets/img/rest3.gif +0 -0
- data/website/static/1.13/assets/img/rethink-rest-graffiti.jpg +0 -0
- data/website/static/1.13/assets/img/why.png +0 -0
- data/website/static/1.13/assets/js/highlight.pack.js +2 -0
- data/website/static/1.13/assets/main.css +15518 -0
- data/website/static/1.13/assets/main.css.map +1 -0
- data/website/static/1.13/bin/bundle +109 -0
- data/website/static/1.13/bin/jekyll +27 -0
- data/website/static/1.13/bin/kramdown +27 -0
- data/website/static/1.13/bin/listen +27 -0
- data/website/static/1.13/bin/rake +27 -0
- data/website/static/1.13/bin/rougify +27 -0
- data/website/static/1.13/bin/safe_yaml +27 -0
- data/website/static/1.13/bin/sass +27 -0
- data/website/static/1.13/bin/sass-convert +27 -0
- data/website/static/1.13/bin/scss +27 -0
- data/website/static/1.13/blog.html +259 -0
- data/website/static/1.13/cheatsheet.html +316 -0
- data/website/static/1.13/cookbooks/authorization.md +0 -0
- data/website/static/1.13/cookbooks/caching.md +0 -0
- data/website/static/1.13/cookbooks/customizing-sideloads.html +325 -0
- data/website/static/1.13/cookbooks/etags.md +0 -0
- data/website/static/1.13/cookbooks/hopping-relationships.html +324 -0
- data/website/static/1.13/cookbooks/json_attributes.md +0 -0
- data/website/static/1.13/cookbooks/openstruct-models.md +0 -0
- data/website/static/1.13/cookbooks/remote-resources.md +0 -0
- data/website/static/1.13/cookbooks/without-activerecord.html +510 -0
- data/website/static/1.13/features.html +249 -0
- data/website/static/1.13/feed.xml +106 -0
- data/website/static/1.13/guides/concepts/backends-and-models.html +467 -0
- data/website/static/1.13/guides/concepts/debugging.html +440 -0
- data/website/static/1.13/guides/concepts/endpoints.html +432 -0
- data/website/static/1.13/guides/concepts/error-handling.html +396 -0
- data/website/static/1.13/guides/concepts/links.html +501 -0
- data/website/static/1.13/guides/concepts/remote-resources.html +536 -0
- data/website/static/1.13/guides/concepts/resources.html +2176 -0
- data/website/static/1.13/guides/concepts/testing.html +1469 -0
- data/website/static/1.13/guides/getting-started/installation.html +420 -0
- data/website/static/1.13/guides/graphiti-rails-migration.html +242 -0
- data/website/static/1.13/guides/index.html +269 -0
- data/website/static/1.13/guides/overview.html +325 -0
- data/website/static/1.13/guides/upgrading-2-0.html +193 -0
- data/website/static/1.13/guides/upgrading.html +314 -0
- data/website/static/1.13/guides/vandal.html +282 -0
- data/website/static/1.13/guides/why.html +1121 -0
- data/website/static/1.13/index.html +72 -0
- data/website/static/1.13/js/authentication.html +295 -0
- data/website/static/1.13/js/ddau.html +238 -0
- data/website/static/1.13/js/extra-params.html +270 -0
- data/website/static/1.13/js/index.html +321 -0
- data/website/static/1.13/js/installation.html +637 -0
- data/website/static/1.13/js/introduction.html +257 -0
- data/website/static/1.13/js/middleware.html +318 -0
- data/website/static/1.13/js/reads/fieldsets.html +271 -0
- data/website/static/1.13/js/reads/filtering.html +289 -0
- data/website/static/1.13/js/reads/includes.html +260 -0
- data/website/static/1.13/js/reads/index.html +497 -0
- data/website/static/1.13/js/reads/nested-queries.html +353 -0
- data/website/static/1.13/js/reads/pagination.html +260 -0
- data/website/static/1.13/js/reads/sorting.html +265 -0
- data/website/static/1.13/js/reads/statistics.html +289 -0
- data/website/static/1.13/js/state-syncing.html +340 -0
- data/website/static/1.13/js/writes/deferred.html +296 -0
- data/website/static/1.13/js/writes/dirty-tracking.html +399 -0
- data/website/static/1.13/js/writes/index.html +391 -0
- data/website/static/1.13/js/writes/nested.html +330 -0
- data/website/static/1.13/js/writes/validations.html +272 -0
- data/website/static/1.13/quickstart.html +660 -0
- data/website/static/1.13/template +161 -0
- data/website/static/1.13/tutorial/index.html +250 -0
- data/website/static/1.13/tutorial/step_0.html +292 -0
- data/website/static/1.13/tutorial/step_1.html +517 -0
- data/website/static/1.13/tutorial/step_2.html +481 -0
- data/website/static/1.13/tutorial/step_3.html +323 -0
- data/website/static/1.13/tutorial/step_4.html +318 -0
- data/website/static/1.13/tutorial/step_5.html +265 -0
- data/website/static/1.13/tutorial/step_6.html +276 -0
- data/website/static/1.13/tutorial/step_7.html +390 -0
- data/website/static/1.13/tutorial/step_8.html +316 -0
- data/website/static/1.13/tutorial/step_9.html +365 -0
- data/website/static/assets/img/error_payload.png +0 -0
- data/website/static/assets/img/legacy/legacy-0378a3bb39.png +0 -0
- data/website/static/assets/img/legacy/legacy-05bbd3e5fd.png +0 -0
- data/website/static/assets/img/legacy/legacy-07aa104495.png +0 -0
- data/website/static/assets/img/legacy/legacy-0c75a16b3a.gif +0 -0
- data/website/static/assets/img/legacy/legacy-3076df6209.png +0 -0
- data/website/static/assets/img/legacy/legacy-7f6889bc89.png +0 -0
- data/website/static/assets/img/legacy/legacy-a2cc4363c3.png +0 -0
- data/website/static/assets/img/legacy/legacy-f67cfa89ab.png +0 -0
- data/website/static/assets/img/meta_total_count.png +0 -0
- data/website/static/img/docusaurus-social-card.jpg +0 -0
- data/website/static/img/docusaurus.png +0 -0
- data/website/static/img/favicon.ico +0 -0
- data/website/static/img/logo.png +0 -0
- data/website/static/img/logo.svg +1 -0
- data/website/static/img/undraw_docusaurus_mountain.svg +171 -0
- data/website/static/img/undraw_docusaurus_react.svg +170 -0
- data/website/static/img/undraw_docusaurus_tree.svg +40 -0
- metadata +245 -46
- data/gemfiles/rails_6.gemfile +0 -18
- data/gemfiles/rails_6_graphiti_rails.gemfile +0 -19
- data/gemfiles/rails_7.gemfile +0 -18
- data/gemfiles/rails_7_1_graphiti_rails.gemfile +0 -19
- data/gemfiles/rails_7_graphiti_rails.gemfile +0 -19
- data/lib/graphiti/railtie.rb +0 -121
- /data/{deprecated_generators → lib/generators}/graphiti/resource_test_generator.rb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/application_resource.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/controller.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/create_request_spec.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/destroy_request_spec.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/resource.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/resource_writes_spec.rb.erb +0 -0
- /data/{deprecated_generators → lib/generators}/graphiti/templates/update_request_spec.rb.erb +0 -0
|
@@ -0,0 +1,501 @@
|
|
|
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="links">Links</h1>
|
|
85
|
+
|
|
86
|
+
<ul>
|
|
87
|
+
<li>1 <a href="#overview">Overview</a>
|
|
88
|
+
<ul>
|
|
89
|
+
<li><a href="#linking-relationships">Linking Relationships</a></li>
|
|
90
|
+
</ul>
|
|
91
|
+
</li>
|
|
92
|
+
<li>2 <a href="#resource-endpoints">Resource Endpoints</a>
|
|
93
|
+
<ul>
|
|
94
|
+
<li><a href="#validation">Validation</a></li>
|
|
95
|
+
</ul>
|
|
96
|
+
</li>
|
|
97
|
+
<li>3 <a href="#configuration">Configuration</a>
|
|
98
|
+
<ul>
|
|
99
|
+
<li><a href="#autolinking">Autolinking</a></li>
|
|
100
|
+
<li><a href="#endpoint-validation">Endpoint Validation</a></li>
|
|
101
|
+
<li><a href="#links-on-demand">Links-On-Demand</a></li>
|
|
102
|
+
<li><a href="#pagination-links">Pagination Links</a></li>
|
|
103
|
+
<li><a href="#custom-endpoint-urls">Custom Endpoint URLs</a></li>
|
|
104
|
+
</ul>
|
|
105
|
+
</li>
|
|
106
|
+
</ul>
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
|
|
110
|
+
<div class="col-md-8">
|
|
111
|
+
|
|
112
|
+
<p align="center">
|
|
113
|
+
<img width="100%" src="https://pbs.twimg.com/media/CeKlfWPUIAATWZZ.jpg" />
|
|
114
|
+
</p>
|
|
115
|
+
|
|
116
|
+
<a class="anchor" id="overview" />
|
|
117
|
+
<a class="header" href="#overview">
|
|
118
|
+
<h2>
|
|
119
|
+
1 Overview
|
|
120
|
+
</h2>
|
|
121
|
+
</a>
|
|
122
|
+
|
|
123
|
+
<p>Links are useful for:</p>
|
|
124
|
+
|
|
125
|
+
<ul>
|
|
126
|
+
<li>Discoverability</li>
|
|
127
|
+
<li>Lazy-loading</li>
|
|
128
|
+
<li>Hiding implementation details</li>
|
|
129
|
+
</ul>
|
|
130
|
+
|
|
131
|
+
<p>Let’s say we’re loading a Post and its “Top Comments”. On Day One, we
|
|
132
|
+
might <strong>eager load</strong> the data like so:</p>
|
|
133
|
+
|
|
134
|
+
<p><code class="language-plaintext highlighter-rouge">/posts/123?include=top_comments</code></p>
|
|
135
|
+
|
|
136
|
+
<p>This fetches all the data in a single request. But after some UI
|
|
137
|
+
testing, we decide to add a “show comments” button. This way our
|
|
138
|
+
page can load more quickly - it only needs to load the Post
|
|
139
|
+
initially, and loading Top Comments can be deferred. We
|
|
140
|
+
want to <strong>lazy load</strong> the relationship.</p>
|
|
141
|
+
|
|
142
|
+
<p>How would we do this? We <em>could</em> bake this logic into our next request:</p>
|
|
143
|
+
|
|
144
|
+
<p><code class="language-plaintext highlighter-rouge">/comments?filter[post_id]=123&filter[upvotes][gte]=100</code></p>
|
|
145
|
+
|
|
146
|
+
<p>But this requires the client to have knowledge of what a “Top Comment”
|
|
147
|
+
is. If this logic ever changed, we’d have to update every client - our
|
|
148
|
+
desktop app, mobile apps, reports, etc… Not to mention, third parties who
|
|
149
|
+
just want to display Top Comments are required to have this knowledge
|
|
150
|
+
and update their implementations as well.</p>
|
|
151
|
+
|
|
152
|
+
<p>Maybe we could hide what “Top Comment” means with a special endpoint:</p>
|
|
153
|
+
|
|
154
|
+
<p><code class="language-plaintext highlighter-rouge">/top_comments?filter[post_id]=123</code></p>
|
|
155
|
+
|
|
156
|
+
<p>But now clients <em>need to know</em> to hit this special endpoint instead of
|
|
157
|
+
the normal <code class="language-plaintext highlighter-rouge">/comments</code> endpoint. How would they know? What if
|
|
158
|
+
<code class="language-plaintext highlighter-rouge">top_comments</code> had special caching rules and <em>shouldn’t</em> be used for
|
|
159
|
+
this purpose?</p>
|
|
160
|
+
|
|
161
|
+
<p>The main problem here is <strong>there is no way to guarantee our lazy-loaded data will
|
|
162
|
+
match our eager loaded data</strong>. Whether we fetch the Post and its Top
|
|
163
|
+
Comments in a single request, or lazy-load that data in a separate
|
|
164
|
+
request, the same data should always be returned.</p>
|
|
165
|
+
|
|
166
|
+
<p align="center">
|
|
167
|
+
<img width="100%" src="/1.13/assets/img/rest2.gif" />
|
|
168
|
+
</p>
|
|
169
|
+
|
|
170
|
+
<p><a href="http://jsonapi.org/format/#document-links">Links</a> solve this problem. When we fetch the Post, the <code class="language-plaintext highlighter-rouge">top_comments</code>
|
|
171
|
+
relationship will contain a URL. Clients can simply follow that URL to
|
|
172
|
+
lazy-load the same data. We can now change the definition of a Top
|
|
173
|
+
Comment - 500 upvotes, factor in recency, apply downvotes - and no
|
|
174
|
+
clients need to change. They simple continue to follow a Link.</p>
|
|
175
|
+
|
|
176
|
+
<a class="anchor" id="linking-relationships" />
|
|
177
|
+
<a class="header" href="#linking-relationships">
|
|
178
|
+
<h3>
|
|
179
|
+
1.1 Linking Relationships
|
|
180
|
+
</h3>
|
|
181
|
+
</a>
|
|
182
|
+
|
|
183
|
+
<p>When defining a relationship, we get a Link for free:</p>
|
|
184
|
+
|
|
185
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">PostResource</span> <span class="o"><</span> <span class="no">ApplicationResource</span>
|
|
186
|
+
<span class="n">has_many</span> <span class="ss">:comments</span>
|
|
187
|
+
<span class="k">end</span></code></pre></figure>
|
|
188
|
+
|
|
189
|
+
<blockquote>
|
|
190
|
+
<p><code class="language-plaintext highlighter-rouge">/comments?filter[post_id]=123</code></p>
|
|
191
|
+
</blockquote>
|
|
192
|
+
|
|
193
|
+
<p>And when customizing a relationship with <code class="language-plaintext highlighter-rouge">params</code>, our Link will be
|
|
194
|
+
updated:</p>
|
|
195
|
+
|
|
196
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span> <span class="k">do</span>
|
|
197
|
+
<span class="n">params</span> <span class="k">do</span> <span class="o">|</span><span class="nb">hash</span><span class="o">|</span>
|
|
198
|
+
<span class="nb">hash</span><span class="p">[</span><span class="ss">:filter</span><span class="p">][</span><span class="ss">:upvotes</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> <span class="ss">gte: </span><span class="mi">100</span> <span class="p">}</span>
|
|
199
|
+
<span class="k">end</span>
|
|
200
|
+
<span class="k">end</span></code></pre></figure>
|
|
201
|
+
|
|
202
|
+
<blockquote>
|
|
203
|
+
<p><code class="language-plaintext highlighter-rouge">/comments?filter[post_id]=123&filter[upvotes][gte]=100</code></p>
|
|
204
|
+
</blockquote>
|
|
205
|
+
|
|
206
|
+
<p>Note: if you use the <code class="language-plaintext highlighter-rouge">scope</code> block directly, it may cause incorrect
|
|
207
|
+
links. Avoid using <code class="language-plaintext highlighter-rouge">scope</code> directly and instead use <code class="language-plaintext highlighter-rouge">params</code> and
|
|
208
|
+
<code class="language-plaintext highlighter-rouge">pre_load</code> if possible.</p>
|
|
209
|
+
|
|
210
|
+
<p>To manually generate a Link:</p>
|
|
211
|
+
|
|
212
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span> <span class="k">do</span>
|
|
213
|
+
<span class="n">link</span> <span class="k">do</span> <span class="o">|</span><span class="n">post</span><span class="o">|</span>
|
|
214
|
+
<span class="n">helpers</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><span class="p">.</span><span class="nf">url_helpers</span>
|
|
215
|
+
<span class="n">helpers</span><span class="p">.</span><span class="nf">comments_url</span><span class="p">(</span><span class="ss">params: </span><span class="p">{</span> <span class="ss">filter: </span><span class="p">{</span> <span class="ss">post_id: </span><span class="n">post</span><span class="p">.</span><span class="nf">id</span> <span class="p">}</span> <span class="p">})</span>
|
|
216
|
+
<span class="c1"># or</span>
|
|
217
|
+
<span class="c1"># http://example.com/api/v1/comments?filter[post_id]=123</span>
|
|
218
|
+
<span class="k">end</span>
|
|
219
|
+
<span class="k">end</span></code></pre></figure>
|
|
220
|
+
|
|
221
|
+
<p>To avoid a Relationship Link altogether:</p>
|
|
222
|
+
|
|
223
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span><span class="p">,</span> <span class="ss">link: </span><span class="kp">false</span></code></pre></figure>
|
|
224
|
+
|
|
225
|
+
<a class="anchor" id="resource-endpoints" />
|
|
226
|
+
<a class="header" href="#resource-endpoints">
|
|
227
|
+
<h2>
|
|
228
|
+
2 Resource Endpoints
|
|
229
|
+
</h2>
|
|
230
|
+
</a>
|
|
231
|
+
|
|
232
|
+
<p>To generate links, we need to associate a Resource to a URL. By default,
|
|
233
|
+
this happens automatically:</p>
|
|
234
|
+
|
|
235
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o"><</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
|
|
236
|
+
<span class="c1"># ... code ...</span>
|
|
237
|
+
<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>
|
|
238
|
+
<span class="k">end</span>
|
|
239
|
+
|
|
240
|
+
<span class="k">class</span> <span class="nc">PostResource</span> <span class="o"><</span> <span class="no">ApplicationResource</span>
|
|
241
|
+
<span class="c1"># under the hood:</span>
|
|
242
|
+
<span class="n">primary_endpoint</span> <span class="s1">'posts'</span><span class="p">,</span>
|
|
243
|
+
<span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">,</span> <span class="ss">:create</span><span class="p">,</span> <span class="ss">:update</span><span class="p">,</span> <span class="ss">:destroy</span><span class="p">]</span>
|
|
244
|
+
<span class="k">end</span></code></pre></figure>
|
|
245
|
+
|
|
246
|
+
<p>Which would generate links to <code class="language-plaintext highlighter-rouge">/api/v1/posts</code>.</p>
|
|
247
|
+
|
|
248
|
+
<a class="anchor" id="validation" />
|
|
249
|
+
<a class="header" href="#validation">
|
|
250
|
+
<h3>
|
|
251
|
+
2.1 Validation
|
|
252
|
+
</h3>
|
|
253
|
+
</a>
|
|
254
|
+
|
|
255
|
+
<p>Associating a Resource to an Endpoint serves two purposes. We’ve gone
|
|
256
|
+
over link generation. But we also want to make sure we’re not linking to
|
|
257
|
+
something that doesn’t actually exist. That’s why we perform <strong>Endpoint
|
|
258
|
+
Validation</strong>.</p>
|
|
259
|
+
|
|
260
|
+
<p>If we tried to access the above resource at a <code class="language-plaintext highlighter-rouge">/comments</code> endpoint:</p>
|
|
261
|
+
|
|
262
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">CommentsController</span> <span class="o"><</span> <span class="no">ApplicationController</span>
|
|
263
|
+
<span class="k">def</span> <span class="nf">index</span>
|
|
264
|
+
<span class="no">PostResource</span><span class="p">.</span><span class="nf">all</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
|
|
265
|
+
<span class="c1"># ...</span>
|
|
266
|
+
<span class="k">end</span>
|
|
267
|
+
<span class="k">end</span></code></pre></figure>
|
|
268
|
+
|
|
269
|
+
<p>We’d get a <code class="language-plaintext highlighter-rouge">Graphiti::Errors::InvalidEndpoint</code> error. Endpoint
|
|
270
|
+
validation ensures that our auto-generated Links are actually valid.</p>
|
|
271
|
+
|
|
272
|
+
<p>To change the endpoint associated to a Resource:</p>
|
|
273
|
+
|
|
274
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">primary_endpoint</span> <span class="s1">'special_posts'</span><span class="p">,</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span></code></pre></figure>
|
|
275
|
+
|
|
276
|
+
<p>Or to alter only the <strong>path</strong>:</p>
|
|
277
|
+
|
|
278
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:path</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'special_posts'</span></code></pre></figure>
|
|
279
|
+
|
|
280
|
+
<p>Or to alter only the <strong>actions</strong> supported:</p>
|
|
281
|
+
|
|
282
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:actions</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span></code></pre></figure>
|
|
283
|
+
|
|
284
|
+
<p>A resource may be accessible by multiple endpoints. Maybe <code class="language-plaintext highlighter-rouge">PostResource</code>
|
|
285
|
+
is also used at <code class="language-plaintext highlighter-rouge">/top_posts</code>. We want to keep all auto-generated links
|
|
286
|
+
pointing to <code class="language-plaintext highlighter-rouge">/posts</code> (the primary endpoint), but <em>allow</em> accessing
|
|
287
|
+
<code class="language-plaintext highlighter-rouge">PostResource</code> from the <code class="language-plaintext highlighter-rouge">/top_posts</code> endpoint:</p>
|
|
288
|
+
|
|
289
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">secondary_endpoint</span> <span class="s1">'/top_posts'</span><span class="p">,</span> <span class="p">[</span><span class="ss">:index</span><span class="p">]</span></code></pre></figure>
|
|
290
|
+
|
|
291
|
+
<a class="anchor" id="configuration" />
|
|
292
|
+
<a class="header" href="#configuration">
|
|
293
|
+
<h2>
|
|
294
|
+
3 Configuration
|
|
295
|
+
</h2>
|
|
296
|
+
</a>
|
|
297
|
+
|
|
298
|
+
<a class="anchor" id="autolinking" />
|
|
299
|
+
<a class="header" href="#autolinking">
|
|
300
|
+
<h3>
|
|
301
|
+
3.1 Autolinking
|
|
302
|
+
</h3>
|
|
303
|
+
</a>
|
|
304
|
+
|
|
305
|
+
<p>To turn off automatically generated links:</p>
|
|
306
|
+
|
|
307
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o"><</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
|
|
308
|
+
<span class="nb">self</span><span class="p">.</span><span class="nf">autolink</span> <span class="o">=</span> <span class="kp">false</span>
|
|
309
|
+
<span class="k">end</span></code></pre></figure>
|
|
310
|
+
|
|
311
|
+
<a class="anchor" id="endpoint-validation" />
|
|
312
|
+
<a class="header" href="#endpoint-validation">
|
|
313
|
+
<h3>
|
|
314
|
+
3.2 Endpoint Validation
|
|
315
|
+
</h3>
|
|
316
|
+
</a>
|
|
317
|
+
|
|
318
|
+
<p>To turn off Endpoint Validation:</p>
|
|
319
|
+
|
|
320
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">ApplicationResource</span> <span class="o"><</span> <span class="no">Graphiti</span><span class="o">::</span><span class="no">Resource</span>
|
|
321
|
+
<span class="nb">self</span><span class="p">.</span><span class="nf">validate_endpoints</span> <span class="o">=</span> <span class="kp">false</span>
|
|
322
|
+
<span class="k">end</span></code></pre></figure>
|
|
323
|
+
|
|
324
|
+
<a class="anchor" id="links-on-demand" />
|
|
325
|
+
<a class="header" href="#links-on-demand">
|
|
326
|
+
<h3>
|
|
327
|
+
3.3 Links-on-Demand
|
|
328
|
+
</h3>
|
|
329
|
+
</a>
|
|
330
|
+
|
|
331
|
+
<p>To only render links when requested in the URL with <code class="language-plaintext highlighter-rouge">?links=true</code>:</p>
|
|
332
|
+
|
|
333
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Graphiti</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
|
|
334
|
+
<span class="n">c</span><span class="p">.</span><span class="nf">links_on_demand</span> <span class="o">=</span> <span class="kp">true</span>
|
|
335
|
+
<span class="k">end</span></code></pre></figure>
|
|
336
|
+
|
|
337
|
+
<a class="anchor" id="pagination-links" />
|
|
338
|
+
<a class="header" href="#pagination-links">
|
|
339
|
+
<h3>
|
|
340
|
+
3.4 Pagination Links
|
|
341
|
+
</h3>
|
|
342
|
+
</a>
|
|
343
|
+
|
|
344
|
+
<p>Requesting big collections can result into slow responses sometimes. In order to avoid this, you could use <a href="https://jsonapi.org/format/#fetching-pagination">pagination</a>. It’ll break your response into smaller pieces that will make your server responds faster. Paginations links can be present in your response in the following ways:</p>
|
|
345
|
+
|
|
346
|
+
<a class="anchor" id="pagination-links-showing-by-default" />
|
|
347
|
+
<a class="header" href="#pagination-links-showing-by-default">
|
|
348
|
+
<h4>
|
|
349
|
+
3.4.1 Showing by default
|
|
350
|
+
</h4>
|
|
351
|
+
</a>
|
|
352
|
+
|
|
353
|
+
<p>With this configuration, all the responses will return the pagination links</p>
|
|
354
|
+
|
|
355
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Graphiti</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
|
|
356
|
+
<span class="n">c</span><span class="p">.</span><span class="nf">pagination_links</span> <span class="o">=</span> <span class="kp">true</span>
|
|
357
|
+
<span class="k">end</span></code></pre></figure>
|
|
358
|
+
|
|
359
|
+
<a class="anchor" id="pagination-links-when-requested" />
|
|
360
|
+
<a class="header" href="#pagination-links-when-requested">
|
|
361
|
+
<h4>
|
|
362
|
+
3.4.2 When requested
|
|
363
|
+
</h4>
|
|
364
|
+
</a>
|
|
365
|
+
|
|
366
|
+
<p>You can showing the pagination links when it was requested in the URL with <code class="language-plaintext highlighter-rouge">?pagination_links=true</code></p>
|
|
367
|
+
|
|
368
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="no">Graphiti</span><span class="p">.</span><span class="nf">configure</span> <span class="k">do</span> <span class="o">|</span><span class="n">c</span><span class="o">|</span>
|
|
369
|
+
<span class="n">c</span><span class="p">.</span><span class="nf">pagination_links_on_demand</span> <span class="o">=</span> <span class="kp">true</span>
|
|
370
|
+
<span class="k">end</span></code></pre></figure>
|
|
371
|
+
|
|
372
|
+
<p>Pagination links won’t show up for <em>#show</em> actions.</p>
|
|
373
|
+
|
|
374
|
+
<a class="anchor" id="custom-endpoint-urls" />
|
|
375
|
+
<a class="header" href="#custom-endpoint-urls">
|
|
376
|
+
<h3>
|
|
377
|
+
3.5 Custom Endpoint URLs
|
|
378
|
+
</h3>
|
|
379
|
+
</a>
|
|
380
|
+
|
|
381
|
+
<p>To change the URL associated with a Resource:</p>
|
|
382
|
+
|
|
383
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="k">class</span> <span class="nc">PostResource</span> <span class="o"><</span> <span class="no">ApplicationResource</span>
|
|
384
|
+
<span class="c1"># Most commonly seen in ApplicationResource</span>
|
|
385
|
+
<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>
|
|
386
|
+
|
|
387
|
+
<span class="n">primary_endpoint</span> <span class="s1">'/posts'</span><span class="p">,</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span>
|
|
388
|
+
<span class="c1"># OR</span>
|
|
389
|
+
<span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:path</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'/posts'</span>
|
|
390
|
+
<span class="c1"># OR</span>
|
|
391
|
+
<span class="nb">self</span><span class="p">.</span><span class="nf">endpoint</span><span class="p">[</span><span class="ss">:actions</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="ss">:index</span><span class="p">,</span> <span class="ss">:show</span><span class="p">]</span>
|
|
392
|
+
<span class="k">end</span></code></pre></figure>
|
|
393
|
+
|
|
394
|
+
<p>To generate a Relationship Link manually:</p>
|
|
395
|
+
|
|
396
|
+
<figure class="highlight"><pre><code class="language-ruby" data-lang="ruby"><span class="n">has_many</span> <span class="ss">:comments</span> <span class="k">do</span>
|
|
397
|
+
<span class="n">link</span> <span class="k">do</span> <span class="o">|</span><span class="n">post</span><span class="o">|</span>
|
|
398
|
+
<span class="n">helpers</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><span class="p">.</span><span class="nf">url_helpers</span>
|
|
399
|
+
<span class="n">helpers</span><span class="p">.</span><span class="nf">comments_url</span><span class="p">(</span><span class="ss">params: </span><span class="p">{</span> <span class="ss">filter: </span><span class="p">{</span> <span class="ss">post_id: </span><span class="n">post</span><span class="p">.</span><span class="nf">id</span> <span class="p">}</span> <span class="p">})</span>
|
|
400
|
+
<span class="c1"># or</span>
|
|
401
|
+
<span class="c1"># http://example.com/api/v1/comments?filter[post_id]=123</span>
|
|
402
|
+
<span class="k">end</span>
|
|
403
|
+
<span class="k">end</span></code></pre></figure>
|
|
404
|
+
|
|
405
|
+
</div>
|
|
406
|
+
|
|
407
|
+
</div>
|
|
408
|
+
</div>
|
|
409
|
+
</main>
|
|
410
|
+
<div class="main-footer main-footer--dark">
|
|
411
|
+
<div class="container">
|
|
412
|
+
<div class="row">
|
|
413
|
+
<div class="col-sm-4 menu">
|
|
414
|
+
<h3>Overview</h3>
|
|
415
|
+
<ul>
|
|
416
|
+
<li>
|
|
417
|
+
<a href="/1.13/quickstart">Quickstart</a>
|
|
418
|
+
</li>
|
|
419
|
+
<li>
|
|
420
|
+
<a href="/1.13/tutorial">Tutorial</a>
|
|
421
|
+
</li>
|
|
422
|
+
<li>
|
|
423
|
+
<a href="/1.13/guides">Guides</a>
|
|
424
|
+
</li>
|
|
425
|
+
</ul>
|
|
426
|
+
</div>
|
|
427
|
+
<div class="col-sm-4 menu">
|
|
428
|
+
<h3>Contact</h3>
|
|
429
|
+
<ul>
|
|
430
|
+
<li>
|
|
431
|
+
<a target="_blank" href="https://discord.gg/wgqkMBsSRV">Discord Chat</a>
|
|
432
|
+
</li>
|
|
433
|
+
<li>
|
|
434
|
+
<a href="mailto:richmolj@gmail.com">Email</a>
|
|
435
|
+
</li>
|
|
436
|
+
</ul>
|
|
437
|
+
</div>
|
|
438
|
+
<div class="col-sm-4 menu">
|
|
439
|
+
<h3>Related</h3>
|
|
440
|
+
<ul>
|
|
441
|
+
<li>
|
|
442
|
+
<a target="_blank" href="http://jsonapi.org">JSONAPI Spec</a>
|
|
443
|
+
</li>
|
|
444
|
+
<li>
|
|
445
|
+
<a target="_blank" href="http://jsonapi-rb.org">jsonapi-rb</a>
|
|
446
|
+
</li>
|
|
447
|
+
<li>
|
|
448
|
+
<a target="_blank" href="https://vuejs.org/">VueJS</a>
|
|
449
|
+
</li>
|
|
450
|
+
</ul>
|
|
451
|
+
</div>
|
|
452
|
+
</div>
|
|
453
|
+
</div>
|
|
454
|
+
</div>
|
|
455
|
+
|
|
456
|
+
<script type="text/javascript">
|
|
457
|
+
$(function () {
|
|
458
|
+
|
|
459
|
+
var flipTabs = function() {
|
|
460
|
+
var isTS = true;
|
|
461
|
+
if (localStorage.getItem('js-lang') === 'javascript') {
|
|
462
|
+
isTS = false;
|
|
463
|
+
}
|
|
464
|
+
|
|
465
|
+
$('.code-tabs').each(function(index, el) {
|
|
466
|
+
if (isTS) {
|
|
467
|
+
console.log('hiding js');
|
|
468
|
+
$($(el).children()[1]).hide();
|
|
469
|
+
$($(el).children()[0]).show();
|
|
470
|
+
} else {
|
|
471
|
+
console.log('hiding ts');
|
|
472
|
+
$($(el).children()[0]).hide();
|
|
473
|
+
$($(el).children()[1]).show();
|
|
474
|
+
}
|
|
475
|
+
});
|
|
476
|
+
|
|
477
|
+
if (isTS) {
|
|
478
|
+
$('.tab.typescript').addClass('active');
|
|
479
|
+
$('.tab.javascript').removeClass('active');
|
|
480
|
+
} else {
|
|
481
|
+
$('.tab.typescript').removeClass('active');
|
|
482
|
+
$('.tab.javascript').addClass('active');
|
|
483
|
+
}
|
|
484
|
+
}
|
|
485
|
+
|
|
486
|
+
$('.tab').click(function() {
|
|
487
|
+
if ($(this).hasClass('typescript')) {
|
|
488
|
+
localStorage.setItem('js-lang', 'typescript');
|
|
489
|
+
} else {
|
|
490
|
+
localStorage.setItem('js-lang', 'javascript');
|
|
491
|
+
}
|
|
492
|
+
|
|
493
|
+
flipTabs();
|
|
494
|
+
});
|
|
495
|
+
|
|
496
|
+
flipTabs();
|
|
497
|
+
})
|
|
498
|
+
</script>
|
|
499
|
+
|
|
500
|
+
</body>
|
|
501
|
+
</html>
|