2019-03-23 08:08:09 -05:00
<!DOCTYPE HTML>
2022-04-12 11:26:39 -05:00
< html lang = "en" class = "sidebar-visible no-js light" >
2019-03-23 08:08:09 -05:00
< head >
<!-- Book generated using mdBook -->
< meta charset = "UTF-8" >
2022-04-12 11:26:39 -05:00
< title > Introduction - Juniper Book (GraphQL server for Rust)< / title >
2023-02-27 13:27:31 -06:00
2022-04-12 11:26:39 -05:00
<!-- Custom HTML head -->
2023-02-27 13:27:31 -06:00
2022-04-12 11:26:39 -05:00
< meta name = "description" content = "User guide for Juniper (GraphQL server library for Rust)." >
2019-03-23 08:08:09 -05:00
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
2022-04-12 11:26:39 -05:00
< link rel = "icon" href = "favicon.svg" >
2021-09-25 23:31:16 -05:00
< link rel = "shortcut icon" href = "favicon.png" >
< link rel = "stylesheet" href = "css/variables.css" >
2019-03-23 08:08:09 -05:00
< link rel = "stylesheet" href = "css/general.css" >
< link rel = "stylesheet" href = "css/chrome.css" >
2021-09-25 23:31:16 -05:00
< link rel = "stylesheet" href = "css/print.css" media = "print" >
2023-02-27 13:27:31 -06:00
2019-03-23 08:08:09 -05:00
<!-- Fonts -->
< link rel = "stylesheet" href = "FontAwesome/css/font-awesome.css" >
2022-04-12 11:26:39 -05:00
< link rel = "stylesheet" href = "fonts/fonts.css" >
2023-02-27 13:27:31 -06:00
2019-03-23 08:08:09 -05:00
<!-- 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 -->
2023-02-27 13:27:31 -06:00
2021-09-25 23:31:16 -05:00
< / head >
2022-04-12 11:26:39 -05:00
< body >
2023-02-27 13:27:31 -06:00
< div id = "body-container" >
2019-03-23 08:08:09 -05:00
<!-- Provide site root to javascript -->
2023-02-27 13:27:31 -06:00
< script >
2022-04-12 11:26:39 -05:00
var path_to_root = "";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
< / script >
2019-03-23 08:08:09 -05:00
<!-- Work around some values being stored in localStorage wrapped in quotes -->
2023-02-27 13:27:31 -06:00
< script >
2019-03-23 08:08:09 -05:00
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 -->
2023-02-27 13:27:31 -06:00
< script >
2019-03-23 08:08:09 -05:00
var theme;
2022-04-12 11:26:39 -05:00
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
if (theme === null || theme === undefined) { theme = default_theme; }
var html = document.querySelector('html');
html.classList.remove('no-js')
html.classList.remove('light')
html.classList.add(theme);
html.classList.add('js');
2019-03-23 08:08:09 -05:00
< / script >
<!-- Hide / unhide sidebar before it is displayed -->
2023-02-27 13:27:31 -06:00
< script >
2019-03-23 08:08:09 -05:00
var html = document.querySelector('html');
2023-04-04 07:07:31 -05:00
var sidebar = null;
2019-03-23 08:08:09 -05:00
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
2023-04-04 07:07:31 -05:00
} else {
sidebar = 'hidden';
2019-03-23 08:08:09 -05:00
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
2022-04-12 11:26:39 -05:00
< div class = "sidebar-scrollbox" >
< ol class = "chapter" > < li class = "chapter-item expanded " > < a href = "index.html" class = "active" > < strong aria-hidden = "true" > 1.< / strong > Introduction< / a > < / li > < li class = "chapter-item expanded " > < a href = "quickstart.html" > < strong aria-hidden = "true" > 2.< / strong > Quickstart< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/index.html" > < strong aria-hidden = "true" > 3.< / strong > Type System< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "types/objects/defining_objects.html" > < strong aria-hidden = "true" > 3.1.< / strong > Defining objects< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "types/objects/complex_fields.html" > < strong aria-hidden = "true" > 3.1.1.< / strong > Complex fields< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/objects/using_contexts.html" > < strong aria-hidden = "true" > 3.1.2.< / strong > Using contexts< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/objects/error_handling.html" > < strong aria-hidden = "true" > 3.1.3.< / strong > Error handling< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "types/other-index.html" > < strong aria-hidden = "true" > 3.2.< / strong > Other types< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "types/enums.html" > < strong aria-hidden = "true" > 3.2.1.< / strong > Enums< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/interfaces.html" > < strong aria-hidden = "true" > 3.2.2.< / strong > Interfaces< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/input_objects.html" > < strong aria-hidden = "true" > 3.2.3.< / strong > Input objects< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/scalars.html" > < strong aria-hidden = "true" > 3.2.4.< / strong > Scalars< / a > < / li > < li class = "chapter-item expanded " > < a href = "types/unions.html" > < strong aria-hidden = "true" > 3.2.5.< / strong > Unions< / a > < / li > < / ol > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "schema/schemas_and_mutations.html" > < strong aria-hidden = "true" > 4.< / strong > Schemas and mutations< / a > < / li > < li class = "chapter-item expanded " > < a href = "servers/index.html" > < strong aria-hidden = "true" > 5.< / strong > Adding A Server< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "servers/official.html" > < strong aria-hidden = "true" > 5.1.< / strong > Official Server Integrations< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "servers/warp.html" > < strong aria-hidden = "true" > 5.1.1.< / strong > Warp< / a > < / li > < li class = "chapter-item expanded " > < a href = "servers/rocket.html" > < strong aria-hidden = "true" > 5.1.2.< / strong > Rocket< / a > < / li > < li class = "chapter-item expanded " > < a href = "servers/iron.html" > < strong aria-hidden = "true" > 5.1.3.< / strong > Iron< / a > < / li > < li class = "chapter-item expanded " > < a href = "servers/hyper.html" > < strong aria-hidden = "true" > 5.1.4.< / strong > Hyper< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "servers/third-party.html" > < strong aria-hidden = "true" > 5.2.< / strong > Third Party Integrations< / a > < / li > < / ol > < / li > < li class = "chapter-item expanded " > < a href = "advanced/index.html" > < strong aria-hidden = "true" > 6.< / strong > Advanced Topics< / a > < / li > < li > < ol class = "section" > < li class = "chapter-item expanded " > < a href = "advanced/introspection.html" > < strong aria-hidden = "true" > 6.1.< / strong > Introspection< / a > < / li > < li class = "chapter-item expanded " > < a href = "advanced/non_struct_objects.html" > < strong aria-hidden = "true" > 6.2.< / strong > Non-struct objects< / a > < / li > < li class = "chapter-item expanded " > < a href = "advanced/implicit_and_explicit_null.html" > < strong aria-hidden = "true" > 6.3.< / strong > Implicit and explicit null< / a > < / li > < li class = "chapter-item expanded " > < a href = "advanced/objects_and_generics.html" > < strong aria-hidden = "true" > 6.4.< / strong > Objects and generics< / a > < / li > < li class = "chapter-item expanded " > < a href = "advanced/multiple_ops_per_request.html" > < strong aria-hidden = "true" > 6.5.< / strong > Multiple operations per request< / a > < / li > < li class = "chapter-item expanded " > < a href = "advanced/dataloaders.html" > < strong aria-hidden = "true" > 6.6.< / strong > Dataloaders< / a > < / li > < li class = "chapter-item expanded " > < a href = "advanced/subscriptions.html" > < strong aria-hidde
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
2019-03-23 08:08:09 -05:00
< / nav >
2023-07-07 07:41:41 -05:00
<!-- Track and set sidebar scroll position -->
< script >
var sidebarScrollbox = document.querySelector('#sidebar .sidebar-scrollbox');
sidebarScrollbox.addEventListener('click', function(e) {
if (e.target.tagName === 'A') {
sessionStorage.setItem('sidebar-scroll', sidebarScrollbox.scrollTop);
}
}, { passive: true });
var sidebarScrollTop = sessionStorage.getItem('sidebar-scroll');
sessionStorage.removeItem('sidebar-scroll');
if (sidebarScrollTop) {
// preserve sidebar scroll position when navigating via links within sidebar
sidebarScrollbox.scrollTop = sidebarScrollTop;
} else {
// scroll sidebar to current active section when navigating via "next/previous chapter" buttons
var activeSection = document.querySelector('#sidebar .active');
if (activeSection) {
activeSection.scrollIntoView({ block: 'center' });
}
}
< / script >
2019-03-23 08:08:09 -05:00
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
2023-02-27 13:27:31 -06:00
< div id = "menu-bar-hover-placeholder" > < / div >
2023-07-07 07:41:41 -05:00
< div id = "menu-bar" class = "menu-bar sticky" >
2022-04-12 11:26:39 -05:00
< div class = "left-buttons" >
< button id = "sidebar-toggle" class = "icon-button" type = "button" title = "Toggle Table of Contents" aria-label = "Toggle Table of Contents" aria-controls = "sidebar" >
< i class = "fa fa-bars" > < / i >
< / button >
< 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" >
2023-02-27 13:27:31 -06:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light< / button > < / li >
2022-04-12 11:26:39 -05:00
< 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 (GraphQL server for Rust)< / 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 >
2023-02-27 13:27:31 -06:00
2019-03-23 08:08:09 -05:00
< / div >
< / div >
2021-09-25 23:31:16 -05:00
< div id = "search-wrapper" class = "hidden" >
2019-03-23 08:08:09 -05:00
< form id = "searchbar-outer" class = "searchbar-outer" >
2022-04-12 11:26:39 -05:00
< input type = "search" id = "searchbar" name = "searchbar" placeholder = "Search this book ..." aria-controls = "searchresults-outer" aria-describedby = "searchresults-header" >
2019-03-23 08:08:09 -05:00
< / form >
< div id = "searchresults-outer" class = "searchresults-outer hidden" >
< div id = "searchresults-header" class = "searchresults-header" > < / div >
< ul id = "searchresults" >
< / ul >
< / div >
< / div >
2023-02-27 13:27:31 -06:00
2019-03-23 08:08:09 -05:00
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
2023-02-27 13:27:31 -06:00
< script >
2019-03-23 08:08:09 -05:00
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 >
2022-04-12 11:26:39 -05:00
< h1 id = "juniper" > < a class = "header" href = "#juniper" > Juniper< / a > < / h1 >
2019-03-23 08:08:09 -05:00
< p > Juniper is a < a href = "http://graphql.org" > GraphQL< / a > server library for Rust. Build type-safe and fast API
servers with minimal boilerplate and configuration.< / p >
< p > < a href = "http://graphql.org" > GraphQL< / a > is a data query language developed by Facebook intended to
serve mobile and web application frontends.< / p >
< p > < em > Juniper< / em > makes it possible to write GraphQL servers in Rust that are
type-safe and blazingly fast. We also try to make declaring and resolving
GraphQL schemas as convenient as possible as Rust will allow.< / p >
< p > Juniper does not include a web server - instead it provides building blocks to
make integration with existing servers straightforward. It optionally provides a
2021-03-01 21:47:41 -06:00
pre-built integration for the < a href = "https://hyper.rs" > Hyper< / a > , < a href = "https://github.com/iron/iron" > Iron< / a > , < a href = "https://rocket.rs" > Rocket< / a > , and < a href = "https://github.com/seanmonstar/warp" > Warp< / a > frameworks, including
2019-03-23 08:08:09 -05:00
embedded < a href = "https://github.com/graphql/graphiql" > Graphiql< / a > for easy debugging.< / p >
< ul >
< li > < a href = "https://crates.io/crates/juniper" > Cargo crate< / a > < / li >
< li > < a href = "https://docs.rs/juniper" > API Reference< / a > < / li >
< / ul >
2022-04-12 11:26:39 -05:00
< h2 id = "features" > < a class = "header" href = "#features" > Features< / a > < / h2 >
2019-03-23 08:08:09 -05:00
< p > Juniper supports the full GraphQL query language according to the
2022-06-28 11:23:38 -05:00
< a href = "https://spec.graphql.org/October2021" > specification (October 2021)< / a > , including interfaces, unions, schema
2019-03-23 08:08:09 -05:00
introspection, and validations.
It does not, however, support the schema language.< / p >
< p > As an exception to other GraphQL libraries for other languages, Juniper builds
non-null types by default. A field of type < code > Vec< Episode> < / code > will be converted into
< code > [Episode!]!< / code > . The corresponding Rust type for e.g. < code > [Episode]< / code > would be
< code > Option< Vec< Option< Episode> > > < / code > .< / p >
2022-04-12 11:26:39 -05:00
< h2 id = "integrations" > < a class = "header" href = "#integrations" > Integrations< / a > < / h2 >
< h3 id = "data-types" > < a class = "header" href = "#data-types" > Data types< / a > < / h3 >
2019-03-23 08:08:09 -05:00
< p > Juniper has automatic integration with some very common Rust crates to make
building schemas a breeze. The types from these crates will be usable in
your Schemas automatically.< / p >
< ul >
< li > < a href = "https://crates.io/crates/uuid" > uuid< / a > < / li >
< li > < a href = "https://crates.io/crates/url" > url< / a > < / li >
< li > < a href = "https://crates.io/crates/chrono" > chrono< / a > < / li >
2020-02-21 00:24:11 -06:00
< li > < a href = "https://crates.io/crates/bson" > bson< / a > < / li >
2019-03-23 08:08:09 -05:00
< / ul >
2022-04-12 11:26:39 -05:00
< h3 id = "web-frameworks" > < a class = "header" href = "#web-frameworks" > Web Frameworks< / a > < / h3 >
2019-03-23 08:08:09 -05:00
< ul >
< li > < a href = "https://hyper.rs" > hyper< / a > < / li >
< li > < a href = "https://rocket.rs" > rocket< / a > < / li >
2021-03-01 21:47:41 -06:00
< li > < a href = "https://github.com/iron/iron" > iron< / a > < / li >
2019-03-23 08:08:09 -05:00
< li > < a href = "https://github.com/seanmonstar/warp" > warp< / a > < / li >
< / ul >
2022-04-12 11:26:39 -05:00
< h2 id = "api-stability" > < a class = "header" href = "#api-stability" > API Stability< / a > < / h2 >
2019-03-23 08:08:09 -05:00
< p > Juniper has not reached 1.0 yet, thus some API instability should be expected.< / p >
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
2023-02-27 13:27:31 -06:00
2022-04-12 11:26:39 -05:00
< a rel = "next" href = "quickstart.html" class = "mobile-nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2023-02-27 13:27:31 -06:00
2019-03-23 08:08:09 -05:00
< div style = "clear: both" > < / div >
< / nav >
< / div >
< / div >
< nav class = "nav-wide-wrapper" aria-label = "Page navigation" >
2023-02-27 13:27:31 -06:00
2022-04-12 11:26:39 -05:00
< a rel = "next" href = "quickstart.html" class = "nav-chapters next" title = "Next chapter" aria-label = "Next chapter" aria-keyshortcuts = "Right" >
< i class = "fa fa-angle-right" > < / i >
< / a >
2021-09-25 23:31:16 -05:00
< / nav >
2019-03-23 08:08:09 -05:00
< / div >
2023-02-27 13:27:31 -06:00
< script >
2022-04-12 11:26:39 -05:00
window.playground_copyable = true;
< / script >
2023-02-27 13:27:31 -06:00
< 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 >
2019-03-23 08:08:09 -05:00
<!-- Custom JS scripts -->
2023-02-27 13:27:31 -06:00
< / div >
2019-03-23 08:08:09 -05:00
< / body >
< / html >
