yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/master/serve/index.html

234 lines
14 KiB
HTML
Raw Normal View History

deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<!DOCTYPE HTML>
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
<html lang="en" class="light sidebar-visible" dir="ltr">
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<head>
<!-- Book generated using mdBook -->
<meta charset="UTF-8">
<title>Serving - Juniper Book</title>
<!-- Custom HTML head -->
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<meta name="description" content="User guide for Juniper (GraphQL server library for Rust).">
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#ffffff">
<link rel="icon" href="../favicon.svg">
<link rel="shortcut icon" href="../favicon.png">
<link rel="stylesheet" href="../css/variables.css">
<link rel="stylesheet" href="../css/general.css">
<link rel="stylesheet" href="../css/chrome.css">
<link rel="stylesheet" href="../css/print.css" media="print">
<!-- Fonts -->
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
<link rel="stylesheet" href="../fonts/fonts.css">
<!-- Highlight.js Stylesheets -->
<link rel="stylesheet" href="../highlight.css">
<link rel="stylesheet" href="../tomorrow-night.css">
<link rel="stylesheet" href="../ayu-highlight.css">
<!-- Custom theme stylesheets -->
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<!-- Provide site root to javascript -->
<script>
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
</script>
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
<!-- Start loading toc.js asap -->
<script src="../toc.js"></script>
</head>
<body>
<div id="body-container">
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<!-- Work around some values being stored in localStorage wrapped in quotes -->
<script>
try {
var theme = localStorage.getItem('mdbook-theme');
var sidebar = localStorage.getItem('mdbook-sidebar');
if (theme.startsWith('"') && theme.endsWith('"')) {
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
}
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
}
} catch (e) { }
</script>
<!-- Set the theme before any content is loaded, prevents flash -->
<script>
var theme;
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
const html = document.documentElement;
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
html.classList.remove('light')
html.classList.add(theme);
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
html.classList.add("js");
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
</script>
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
<!-- Hide / unhide sidebar before it is displayed -->
<script>
var sidebar = null;
var sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
} else {
sidebar = 'hidden';
}
sidebar_toggle.checked = sidebar === 'visible';
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
</script>
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
<!-- populated by js -->
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
<noscript>
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
</noscript>
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
<div class="sidebar-resize-indicator"></div>
</div>
</nav>
<div id="page-wrapper" class="page-wrapper">
<div class="page">
deploy: b32004f02277381cef22877ab97dff900e2e263c
2024-11-14 12:07:28 -06:00
<div id="menu-bar-hover-placeholder"></div>
deploy: 63f6f8fae43e9517469d8e316bca382b7e20750a
2024-03-20 11:02:18 -05:00
<div id="menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
<i class="fa fa-bars"></i>
</label>
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
<i class="fa fa-paint-brush"></i>
</button>
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
</ul>
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
<i class="fa fa-search"></i>
</button>
</div>
<h1 class="menu-title">Juniper Book</h1>
<div class="right-buttons">
<a href="../print.html" title="Print this book" aria-label="Print this book">
<i id="print-button" class="fa fa-print"></i>
</a>
</div>
</div>
<div id="search-wrapper" class="hidden">
<form id="searchbar-outer" class="searchbar-outer">
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
</form>
<div id="searchresults-outer" class="searchresults-outer hidden">
<div id="searchresults-header" class="searchresults-header"></div>
<ul id="searchresults">
</ul>
</div>
</div>
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
<script>
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
});
</script>
<div id="content" class="content">
<main>
<h1 id="serving"><a class="header" href="#serving">Serving</a></h1>
<p>Once we have built a <a href="../schema/index.html">GraphQL schema</a>, the next obvious step would be to serve it, so clients can interact with our <a href="https://graphql.org">GraphQL</a> API. Usually, <a href="https://graphql.org">GraphQL</a> APIs are served via <a href="https://en.wikipedia.org/wiki/HTTP">HTTP</a>.</p>
<h2 id="web-server-frameworks"><a class="header" href="#web-server-frameworks">Web server frameworks</a></h2>
<p>Though the <a href="https://docs.rs/juniper"><code>juniper</code></a> crate doesn't provide a built-in <a href="https://en.wikipedia.org/wiki/HTTP">HTTP</a> server, the surrounding ecosystem does.</p>
<h3 id="officially-supported"><a class="header" href="#officially-supported">Officially supported</a></h3>
<p><a href="https://docs.rs/juniper">Juniper</a> officially supports the following widely used and adopted web server frameworks in <a href="https://www.rust-lang.org">Rust</a> ecosystem:</p>
<ul>
<li><a href="https://docs.rs/actix-web"><code>actix-web</code></a> (<a href="https://docs.rs/juniper_actix"><code>juniper_actix</code></a> crate)</li>
<li><a href="https://docs.rs/axum"><code>axum</code></a> (<a href="https://docs.rs/juniper_axum"><code>juniper_axum</code></a> crate)</li>
<li><a href="https://docs.rs/hyper"><code>hyper</code></a> ([<code>juniper_hyper</code>] crate)</li>
<li><a href="https://docs.rs/rocket"><code>rocket</code></a> (<a href="https://docs.rs/juniper_rocket"><code>juniper_rocket</code></a> crate)</li>
<li><a href="https://docs.rs/warp"><code>warp</code></a> (<a href="https://docs.rs/juniper_warp"><code>juniper_warp</code></a> crate)</li>
</ul>
<p>See their API docs and usage examples (accessible from API docs) for further details of how they should be used.</p>
<blockquote>
<p><strong>NOTE</strong>: All the officially supported web server framework integrations provide a simple and convenient way for exposing <a href="https://github.com/graphql/graphiql">GraphiQL</a> and/or <a href="https://github.com/prisma/graphql-playground">GraphQL Playground</a> with the <a href="../schema/index.html">GraphQL schema</a> along. These powerful tools ease the development process by enabling you to explore and send client requests to the <a href="https://graphql.org">GraphQL</a> API under development.</p>
</blockquote>
<h2 id="websocket"><a class="header" href="#websocket">WebSocket</a></h2>
<blockquote>
<p><strong>NOTE</strong>: <a href="https://en.wikipedia.org/wiki/WebSocket">WebSocket</a> is a crucial part for serving <a href="../schema/subscriptions.html">GraphQL subscriptions</a> over <a href="https://en.wikipedia.org/wiki/HTTP">HTTP</a>.</p>
</blockquote>
<p>There are two widely adopted protocols for serving <a href="https://graphql.org">GraphQL</a> over <a href="https://en.wikipedia.org/wiki/WebSocket">WebSocket</a>:</p>
<ol>
<li><a href="https://github.com/apollographql/subscriptions-transport-ws/blob/v0.11.0/PROTOCOL.md">Legacy <code>graphql-ws</code> GraphQL over WebSocket Protocol</a>, formerly used by <a href="https://www.apollographql.com">Apollo</a> and the <a href="https://npmjs.com/package/subscriptions-transport-ws"><code>subscriptions-transport-ws</code> npm package</a>, and now being deprecated.</li>
<li><a href="https://github.com/enisdenjo/graphql-ws/blob/v5.14.0/PROTOCOL.md">New <code>graphql-transport-ws</code> GraphQL over WebSocket Protocol</a>, provided by the <a href="https://npmjs.com/package/graphql-ws"><code>graphql-ws</code> npm package</a> and being used by <a href="https://www.apollographql.com">Apollo</a> as for now.</li>
</ol>
<p>In the <a href="https://docs.rs/juniper">Juniper</a> ecosystem, both implementations are provided by the <a href="https://docs.rs/juniper_graphql_ws"><code>juniper_graphql_ws</code></a> crate. Most of the <a href="#officially-supported">officially supported web server framework integrations</a> are able to serve a <a href="../schema/index.html">GraphQL schema</a> over <a href="https://en.wikipedia.org/wiki/WebSocket">WebSocket</a> (including <a href="../schema/subscriptions.html">subscriptions</a>) and even support <a href="https://developer.mozilla.org/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#subprotocols">auto-negotiation of the correct protocol based on the <code>Sec-Websocket-Protocol</code> HTTP header value</a>. See their API docs and usage examples (accessible from API docs) for further details of how to do so.</p>
</main>
<nav class="nav-wrapper" aria-label="Page navigation">
<!-- Mobile navigation buttons -->
<a rel="prev" href="../schema/introspection.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../serve/batching.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
<div style="clear: both"></div>
</nav>
</div>
</div>
<nav class="nav-wide-wrapper" aria-label="Page navigation">
<a rel="prev" href="../schema/introspection.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
<i class="fa fa-angle-left"></i>
</a>
<a rel="next prefetch" href="../serve/batching.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
<i class="fa fa-angle-right"></i>
</a>
</nav>
</div>
<script>
window.playground_copyable = true;
</script>
<script src="../elasticlunr.min.js"></script>
<script src="../mark.min.js"></script>
<script src="../searcher.js"></script>
<script src="../clipboard.min.js"></script>
<script src="../highlight.js"></script>
<script src="../book.js"></script>
<!-- Custom JS scripts -->
</div>
</body>
</html>
Reference in a new issue Copy permalink