2019-03-23 08:08:09 -05:00
<!DOCTYPE HTML>
2020-02-21 00:24:11 -06: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" >
< title > Iron - Juniper - GraphQL Server for Rust< / title >
2020-02-21 00:24:11 -06:00
2019-03-23 08:08:09 -05:00
< meta content = "text/html; charset=utf-8" http-equiv = "Content-Type" >
< meta name = "description" content = "Documentation for juniper, a GraphQL server library for Rust." >
< meta name = "viewport" content = "width=device-width, initial-scale=1" >
< meta name = "theme-color" content = "#ffffff" / >
< 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 href = "https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800" rel = "stylesheet" type = "text/css" >
< link href = "https://fonts.googleapis.com/css?family=Source+Code+Pro:500" rel = "stylesheet" type = "text/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 -->
< / head >
2020-02-21 00:24:11 -06:00
< body >
2019-03-23 08:08:09 -05:00
<!-- Provide site root to javascript -->
2020-02-21 00:24:11 -06:00
< script type = "text/javascript" >
var path_to_root = "../";
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "light" : "light";
< / script >
2019-03-23 08:08:09 -05:00
<!-- Work around some values being stored in localStorage wrapped in quotes -->
< script type = "text/javascript" >
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 type = "text/javascript" >
var theme;
2020-02-21 00:24:11 -06: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 -->
< script type = "text/javascript" >
var html = document.querySelector('html');
var sidebar = 'hidden';
if (document.body.clientWidth >= 1080) {
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
sidebar = sidebar || 'visible';
}
html.classList.remove('sidebar-visible');
html.classList.add("sidebar-" + sidebar);
< / script >
< nav id = "sidebar" class = "sidebar" aria-label = "Table of contents" >
2020-02-21 00:24:11 -06:00
< div id = "sidebar-scrollbox" class = "sidebar-scrollbox" >
< ol class = "chapter" > < li class = "expanded affix " > < a href = "../index.html" > Introduction< / a > < / li > < li class = "expanded affix " > < a href = "../quickstart.html" > Quickstart< / a > < / li > < li class = "expanded affix " > < a href = "../types/index.html" > Type System< / a > < / li > < li class = "expanded " > < a href = "../types/objects/defining_objects.html" > < strong aria-hidden = "true" > 1.< / strong > Defining objects< / a > < / li > < li > < ol class = "section" > < li class = "expanded " > < a href = "../types/objects/complex_fields.html" > < strong aria-hidden = "true" > 1.1.< / strong > Complex fields< / a > < / li > < li class = "expanded " > < a href = "../types/objects/using_contexts.html" > < strong aria-hidden = "true" > 1.2.< / strong > Using contexts< / a > < / li > < li class = "expanded " > < a href = "../types/objects/error_handling.html" > < strong aria-hidden = "true" > 1.3.< / strong > Error handling< / a > < / li > < / ol > < / li > < li class = "expanded " > < a href = "../types/other-index.html" > < strong aria-hidden = "true" > 2.< / strong > Other types< / a > < / li > < li > < ol class = "section" > < li class = "expanded " > < a href = "../types/enums.html" > < strong aria-hidden = "true" > 2.1.< / strong > Enums< / a > < / li > < li class = "expanded " > < a href = "../types/interfaces.html" > < strong aria-hidden = "true" > 2.2.< / strong > Interfaces< / a > < / li > < li class = "expanded " > < a href = "../types/input_objects.html" > < strong aria-hidden = "true" > 2.3.< / strong > Input objects< / a > < / li > < li class = "expanded " > < a href = "../types/scalars.html" > < strong aria-hidden = "true" > 2.4.< / strong > Scalars< / a > < / li > < li class = "expanded " > < a href = "../types/unions.html" > < strong aria-hidden = "true" > 2.5.< / strong > Unions< / a > < / li > < / ol > < / li > < li class = "expanded " > < a href = "../schema/schemas_and_mutations.html" > < strong aria-hidden = "true" > 3.< / strong > Schemas and mutations< / a > < / li > < li class = "expanded " > < a href = "../servers/index.html" > < strong aria-hidden = "true" > 4.< / strong > Adding A Server< / a > < / li > < li > < ol class = "section" > < li class = "expanded " > < a href = "../servers/official.html" > < strong aria-hidden = "true" > 4.1.< / strong > Official Server Integrations< / a > < / li > < li > < ol class = "section" > < li class = "expanded " > < a href = "../servers/warp.html" > < strong aria-hidden = "true" > 4.1.1.< / strong > Warp< / a > < / li > < li class = "expanded " > < a href = "../servers/rocket.html" > < strong aria-hidden = "true" > 4.1.2.< / strong > Rocket< / a > < / li > < li class = "expanded " > < a href = "../servers/iron.html" class = "active" > < strong aria-hidden = "true" > 4.1.3.< / strong > Iron< / a > < / li > < li class = "expanded " > < a href = "../servers/hyper.html" > < strong aria-hidden = "true" > 4.1.4.< / strong > Hyper< / a > < / li > < / ol > < / li > < li class = "expanded " > < a href = "../servers/third-party.html" > < strong aria-hidden = "true" > 4.2.< / strong > Third Party Integrations< / a > < / li > < / ol > < / li > < li class = "expanded " > < a href = "../advanced/index.html" > < strong aria-hidden = "true" > 5.< / strong > Advanced Topics< / a > < / li > < li > < ol class = "section" > < li class = "expanded " > < a href = "../advanced/introspection.html" > < strong aria-hidden = "true" > 5.1.< / strong > Introspection< / a > < / li > < li class = "expanded " > < a href = "../advanced/non_struct_objects.html" > < strong aria-hidden = "true" > 5.2.< / strong > Non-struct objects< / a > < / li > < li class = "expanded " > < a href = "../advanced/objects_and_generics.html" > < strong aria-hidden = "true" > 5.3.< / strong > Objects and generics< / a > < / li > < li class = "expanded " > < a href = "../advanced/multiple_ops_per_request.html" > < strong aria-hidden = "true" > 5.4.< / strong > Multiple operations per request< / a > < / li > < li class = "expanded " > < a href = "../advanced/dataloaders.html" > < strong aria-hidden = "true" > 5.5.< / strong > Dataloaders< / a > < / li > < / ol > < / li > < / ol >
< / div >
< div id = "sidebar-resize-handle" class = "sidebar-resize-handle" > < / div >
2019-03-23 08:08:09 -05:00
< / nav >
< div id = "page-wrapper" class = "page-wrapper" >
< div class = "page" >
< div id = "menu-bar" class = "menu-bar" >
< div id = "menu-bar-sticky-container" >
< 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" >
2020-02-21 00:24:11 -06:00
< li role = "none" > < button role = "menuitem" class = "theme" id = "light" > Light (default)< / button > < / li >
2019-03-23 08:08:09 -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 >
2020-02-21 00:24:11 -06:00
< h1 class = "menu-title" > Juniper - GraphQL Server for Rust< / h1 >
2019-03-23 08:08:09 -05:00
< 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 >
2020-02-21 00:24:11 -06:00
2019-03-23 08:08:09 -05:00
< / div >
< / div >
< / div >
< div id = "search-wrapper" class = "hidden" >
< form id = "searchbar-outer" class = "searchbar-outer" >
< input type = "search" name = "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 type = "text/javascript" >
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 >
2020-02-21 00:24:11 -06:00
< h1 > < a class = "header" href = "#integrating-with-iron" id = "integrating-with-iron" > Integrating with Iron< / a > < / h1 >
2019-03-23 08:08:09 -05:00
< p > < a href = "http://ironframework.io" > Iron< / a > is a library that's been around for a while in the Rust sphere but lately
hasn't seen much of development. Nevertheless, it's still a solid library with a
familiar request/response/middleware architecture that works on Rust's stable
channel.< / p >
< p > Juniper's Iron integration is contained in the < code > juniper_iron< / code > crate:< / p >
< p > !FILENAME Cargo.toml< / p >
< pre > < code class = "language-toml" > [dependencies]
juniper = " 0.10"
juniper_iron = " 0.2.0"
< / code > < / pre >
< p > Included in the source is a < a href = "https://github.com/graphql-rust/juniper_iron/blob/master/examples/iron_server.rs" > small
example< / a >
which sets up a basic GraphQL and < a href = "https://github.com/graphql/graphiql" > GraphiQL< / a > handler.< / p >
2020-02-21 00:24:11 -06:00
< h2 > < a class = "header" href = "#basic-integration" id = "basic-integration" > Basic integration< / a > < / h2 >
2019-03-23 08:08:09 -05:00
< p > Let's start with a minimal schema and just get a GraphQL endpoint up and
running. We use < a href = "https://github.com/iron/mount" > mount< / a > to attach the GraphQL handler at < code > /graphql< / code > .< / p >
< p > The < code > context_factory< / code > function will be executed on every request and can be used
to set up database connections, read session token information from cookies, and
set up other global data that the schema might require.< / p >
< p > In this example, we won't use any global data so we just return an empty value.< / p >
< pre > < code class = "language-rust ignore" > extern crate juniper;
extern crate juniper_iron;
extern crate iron;
extern crate mount;
use mount::Mount;
use iron::prelude::*;
use juniper::EmptyMutation;
use juniper_iron::GraphQLHandler;
fn context_factory(_: & mut Request) -> IronResult< ()> {
Ok(())
}
struct Root;
2020-02-21 00:24:11 -06:00
#[juniper::graphql_object]
2019-05-14 01:52:54 -05:00
impl Root {
fn foo() -> String {
2019-03-23 08:08:09 -05:00
" Bar" .to_owned()
}
2019-05-14 01:52:54 -05:00
}
2019-03-23 08:08:09 -05:00
2020-02-21 00:24:11 -06:00
< span class = "boring" > #[allow(unreachable_code, unused_variables)]
< / span > fn main() {
2019-03-23 08:08:09 -05:00
let mut mount = Mount::new();
let graphql_endpoint = GraphQLHandler::new(
context_factory,
Root,
EmptyMutation::< ()> ::new(),
);
mount.mount(" /graphql" , graphql_endpoint);
let chain = Chain::new(mount);
2020-02-21 00:24:11 -06:00
< span class = "boring" > return;
< / span > Iron::new(chain).http(" 0.0.0.0:8080" ).unwrap();
2019-03-23 08:08:09 -05:00
}
< / code > < / pre >
2020-02-21 00:24:11 -06:00
< h2 > < a class = "header" href = "#accessing-data-from-the-request" id = "accessing-data-from-the-request" > Accessing data from the request< / a > < / h2 >
2019-03-23 08:08:09 -05:00
< p > If you want to access e.g. the source IP address of the request from a field
2019-04-09 19:26:56 -05:00
resolver, you need to pass this data using Juniper's < a href = "../types/objects/using_contexts.html" > context feature< / a > .< / p >
2020-02-21 00:24:11 -06:00
< pre > < code class = "language-rust ignore" > < span class = "boring" > extern crate juniper;
< / span > < span class = "boring" > extern crate juniper_iron;
< / span > < span class = "boring" > extern crate iron;
< / span > < span class = "boring" > use iron::prelude::*;
< / span > use std::net::SocketAddr;
2019-03-23 08:08:09 -05:00
struct Context {
remote_addr: SocketAddr,
}
impl juniper::Context for Context {}
fn context_factory(req: & mut Request) -> IronResult< Context> {
Ok(Context {
remote_addr: req.remote_addr
})
}
struct Root;
2020-02-21 00:24:11 -06:00
#[juniper::graphql_object(
2019-05-14 01:52:54 -05:00
Context = Context,
)]
impl Root {
field my_addr(context: & Context) -> String {
2019-03-23 08:08:09 -05:00
format!(" Hello, you're coming from {}" , context.remote_addr)
}
2019-05-14 01:52:54 -05:00
}
2019-03-23 08:08:09 -05:00
2020-02-21 00:24:11 -06:00
< span class = "boring" > fn main() {
< / span > < span class = "boring" > let _graphql_endpoint = juniper_iron::GraphQLHandler::new(
< / span > < span class = "boring" > context_factory,
< / span > < span class = "boring" > Root,
< / span > < span class = "boring" > juniper::EmptyMutation::< Context> ::new(),
< / span > < span class = "boring" > );
< / span > < span class = "boring" > }
< / span > < / code > < / pre >
2019-03-23 08:08:09 -05:00
< / main >
< nav class = "nav-wrapper" aria-label = "Page navigation" >
<!-- Mobile navigation buttons -->
< a rel = "prev" href = "../servers/rocket.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" href = "../servers/hyper.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 href = "../servers/rocket.html" class = "nav-chapters previous" title = "Previous chapter" aria-label = "Previous chapter" aria-keyshortcuts = "Left" >
< i class = "fa fa-angle-left" > < / i >
< / a >
< a href = "../servers/hyper.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 >
2020-02-21 00:24:11 -06:00
< script type = "text/javascript" >
window.playpen_copyable = true;
< / script >
2019-03-23 08:08:09 -05:00
< script src = "../elasticlunr.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../mark.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../searcher.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../clipboard.min.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../highlight.js" type = "text/javascript" charset = "utf-8" > < / script >
< script src = "../book.js" type = "text/javascript" charset = "utf-8" > < / script >
<!-- Custom JS scripts -->
< / body >
< / html >
