mirror of https://github.com/vapor/docs.git
2197 lines
58 KiB
HTML
2197 lines
58 KiB
HTML
|
|
<!DOCTYPE html>
|
|
<html class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
|
|
|
|
|
|
<link rel="shortcut icon" href="../../assets/images/favicon.png">
|
|
|
|
<meta name="generator" content="mkdocs-0.16.3, mkdocs-material-1.1.1">
|
|
|
|
|
|
|
|
<title>Request - Vapor Docs</title>
|
|
|
|
|
|
|
|
<script src="../../assets/javascripts/modernizr-56ade86843.js"></script>
|
|
|
|
|
|
<link rel="stylesheet" href="../../assets/stylesheets/application-e5b48ab351.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto Slab:300,400,400i,700|Source+Code+Pro">
|
|
<style>body,input{font-family:"Roboto Slab","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Source Code Pro","Courier New",Courier,monospace}</style>
|
|
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
|
|
|
|
|
|
<link rel="stylesheet" href="../../stylesheets/extra.css">
|
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
<body>
|
|
|
|
<svg class="md-svg">
|
|
<defs>
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" width="416" height="448" viewBox="0 0 416 448" id="github"><path fill="currentColor" d="M160 304q0 10-3.125 20.5t-10.75 19T128 352t-18.125-8.5-10.75-19T96 304t3.125-20.5 10.75-19T128 256t18.125 8.5 10.75 19T160 304zm160 0q0 10-3.125 20.5t-10.75 19T288 352t-18.125-8.5-10.75-19T256 304t3.125-20.5 10.75-19T288 256t18.125 8.5 10.75 19T320 304zm40 0q0-30-17.25-51T296 232q-10.25 0-48.75 5.25Q229.5 240 208 240t-39.25-2.75Q130.75 232 120 232q-29.5 0-46.75 21T56 304q0 22 8 38.375t20.25 25.75 30.5 15 35 7.375 37.25 1.75h42q20.5 0 37.25-1.75t35-7.375 30.5-15 20.25-25.75T360 304zm56-44q0 51.75-15.25 82.75-9.5 19.25-26.375 33.25t-35.25 21.5-42.5 11.875-42.875 5.5T212 416q-19.5 0-35.5-.75t-36.875-3.125-38.125-7.5-34.25-12.875T37 371.5t-21.5-28.75Q0 312 0 260q0-59.25 34-99-6.75-20.5-6.75-42.5 0-29 12.75-54.5 27 0 47.5 9.875t47.25 30.875Q171.5 96 212 96q37 0 70 8 26.25-20.5 46.75-30.25T376 64q12.75 25.5 12.75 54.5 0 21.75-6.75 42 34 40 34 99.5z"/></svg>
|
|
|
|
</defs>
|
|
</svg>
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="drawer">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="search">
|
|
<label class="md-overlay" data-md-component="overlay" for="drawer"></label>
|
|
|
|
<header class="md-header">
|
|
<nav class="md-header-nav md-grid">
|
|
<div class="md-flex">
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
|
|
<a href="../.." title="Vapor Docs" class="md-logo md-header-nav__button">
|
|
<img src="../../images/droplet-white.svg" width="24" height="24">
|
|
</a>
|
|
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<label class="md-icon md-icon--menu md-header-nav__button" for="drawer"></label>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--stretch">
|
|
<span class="md-flex__ellipsis md-header-nav__title">
|
|
|
|
|
|
|
|
<span class="md-header-nav__parent">
|
|
HTTP
|
|
</span>
|
|
|
|
|
|
Request
|
|
|
|
</span>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
|
|
<label class="md-icon md-icon--search md-header-nav__button" for="search"></label>
|
|
|
|
<div class="md-search" data-md-component="search">
|
|
<div class="md-search__overlay"></div>
|
|
<div class="md-search__inner">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" placeholder="Search" accesskey="s" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query">
|
|
<label class="md-icon md-search__icon" for="search"></label>
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="result"></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<div class="md-header-nav__source">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
|
|
|
|
<div class="md-source__icon">
|
|
<svg viewBox="0 0 24 24" width="24" height="24">
|
|
<use xlink:href="#github" width="24" height="24"></use>
|
|
</svg>
|
|
</div>
|
|
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
</header>
|
|
|
|
<div class="md-container">
|
|
|
|
|
|
<main class="md-main">
|
|
<div class="md-main__inner md-grid" data-md-component="container">
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="navigation">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
<nav class="md-nav md-nav--primary" data-md-level="0">
|
|
<label class="md-nav__title md-nav__title--site" for="drawer">
|
|
|
|
<i class="md-logo md-nav__button">
|
|
<img src="../../images/droplet-white.svg">
|
|
</i>
|
|
|
|
Vapor Docs
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/vapor/documentation" title="Go to repository" class="md-source" data-md-source="github">
|
|
|
|
<div class="md-source__icon">
|
|
<svg viewBox="0 0 24 24" width="24" height="24">
|
|
<use xlink:href="#github" width="24" height="24"></use>
|
|
</svg>
|
|
</div>
|
|
|
|
<div class="md-source__repository">
|
|
GitHub
|
|
</div>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../.." title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2">
|
|
|
|
<label class="md-nav__link" for="nav-2">
|
|
Getting started
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-2">
|
|
Getting started
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/install-on-macos/" title="Install: macOS" class="md-nav__link">
|
|
Install: macOS
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/install-on-ubuntu/" title="Install: Ubuntu" class="md-nav__link">
|
|
Install: Ubuntu
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/toolbox/" title="Toolbox" class="md-nav__link">
|
|
Toolbox
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/hello-world/" title="Hello, World" class="md-nav__link">
|
|
Hello, World
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/manual/" title="Manual" class="md-nav__link">
|
|
Manual
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../getting-started/xcode/" title="Xcode" class="md-nav__link">
|
|
Xcode
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3">
|
|
|
|
<label class="md-nav__link" for="nav-3">
|
|
Vapor
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-3">
|
|
Vapor
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/folder-structure/" title="Folder Structure" class="md-nav__link">
|
|
Folder Structure
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/droplet/" title="Droplet" class="md-nav__link">
|
|
Droplet
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/views/" title="Views" class="md-nav__link">
|
|
Views
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/controllers/" title="Controllers" class="md-nav__link">
|
|
Controllers
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/provider/" title="Provider" class="md-nav__link">
|
|
Provider
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/hash/" title="Hash" class="md-nav__link">
|
|
Hash
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/log/" title="Log" class="md-nav__link">
|
|
Log
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../vapor/commands/" title="Commands" class="md-nav__link">
|
|
Commands
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-4" type="checkbox" id="nav-4">
|
|
|
|
<label class="md-nav__link" for="nav-4">
|
|
Configs
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-4">
|
|
Configs
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../configs/config/" title="Config" class="md-nav__link">
|
|
Config
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-5" type="checkbox" id="nav-5">
|
|
|
|
<label class="md-nav__link" for="nav-5">
|
|
JSON
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-5">
|
|
JSON
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../json/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../json/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-6" type="checkbox" id="nav-6">
|
|
|
|
<label class="md-nav__link" for="nav-6">
|
|
Routing
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-6">
|
|
Routing
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../routing/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../routing/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../routing/parameters/" title="Parameters" class="md-nav__link">
|
|
Parameters
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../routing/group/" title="Group" class="md-nav__link">
|
|
Group
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../routing/collection/" title="Collection" class="md-nav__link">
|
|
Collection
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-7" type="checkbox" id="nav-7">
|
|
|
|
<label class="md-nav__link" for="nav-7">
|
|
Fluent
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-7">
|
|
Fluent
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../fluent/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../fluent/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../fluent/model/" title="Model" class="md-nav__link">
|
|
Model
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../fluent/database/" title="Database" class="md-nav__link">
|
|
Database
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../fluent/query/" title="Query" class="md-nav__link">
|
|
Query
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../fluent/relations/" title="Relations" class="md-nav__link">
|
|
Relations
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-8" type="checkbox" id="nav-8">
|
|
|
|
<label class="md-nav__link" for="nav-8">
|
|
Cache
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-8">
|
|
Cache
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cache/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../cache/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-9" type="checkbox" id="nav-9">
|
|
|
|
<label class="md-nav__link" for="nav-9">
|
|
MySQL
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-9">
|
|
MySQL
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mysql/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mysql/provider/" title="Provider" class="md-nav__link">
|
|
Provider
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../mysql/driver/" title="Driver" class="md-nav__link">
|
|
Driver
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-10" type="checkbox" id="nav-10">
|
|
|
|
<label class="md-nav__link" for="nav-10">
|
|
Redis
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-10">
|
|
Redis
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../redis/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../redis/provider/" title="Provider" class="md-nav__link">
|
|
Provider
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-11" type="checkbox" id="nav-11">
|
|
|
|
<label class="md-nav__link" for="nav-11">
|
|
Auth
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-11">
|
|
Auth
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/provider/" title="Provider" class="md-nav__link">
|
|
Provider
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/helper/" title="Helper" class="md-nav__link">
|
|
Helper
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/password/" title="Password" class="md-nav__link">
|
|
Password
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/persist/" title="Persist" class="md-nav__link">
|
|
Persist
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../auth/redirect-middleware/" title="Redirect Middleware" class="md-nav__link">
|
|
Redirect Middleware
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-12" type="checkbox" id="nav-12">
|
|
|
|
<label class="md-nav__link" for="nav-12">
|
|
JWT
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-12">
|
|
JWT
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../jwt/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../jwt/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-13" type="checkbox" id="nav-13">
|
|
|
|
<label class="md-nav__link" for="nav-13">
|
|
Sessions
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-13">
|
|
Sessions
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../sessions/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../sessions/sessions/" title="Sessions" class="md-nav__link">
|
|
Sessions
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-14" type="checkbox" id="nav-14" checked>
|
|
|
|
<label class="md-nav__link" for="nav-14">
|
|
HTTP
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-14">
|
|
HTTP
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="toc">
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="toc">
|
|
Request
|
|
</label>
|
|
|
|
<a href="./" title="Request" class="md-nav__link md-nav__link--active">
|
|
Request
|
|
</a>
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="toc">Table of contents</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#method" title="Method" class="md-nav__link">
|
|
Method
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#uri" title="URI" class="md-nav__link">
|
|
URI
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#route-parameters" title="Route Parameters" class="md-nav__link">
|
|
Route Parameters
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#headers" title="Headers" class="md-nav__link">
|
|
Headers
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#extending-headers" title="Extending Headers" class="md-nav__link">
|
|
Extending Headers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#body" title="Body" class="md-nav__link">
|
|
Body
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#content" title="Content" class="md-nav__link">
|
|
Content
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#form-data" title="Form Data" class="md-nav__link">
|
|
Form Data
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#json" title="JSON" class="md-nav__link">
|
|
JSON
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#query-parameters" title="Query Parameters" class="md-nav__link">
|
|
Query Parameters
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#key-paths" title="Key Paths" class="md-nav__link">
|
|
Key Paths
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#metadata" title="Metadata" class="md-nav__link">
|
|
Metadata
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#items" title="Items" class="md-nav__link">
|
|
Items
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#mixing-arrays-and-objects" title="Mixing Arrays and Objects" class="md-nav__link">
|
|
Mixing Arrays and Objects
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#array-item" title="Array Item" class="md-nav__link">
|
|
Array Item
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#array-comprehension" title="Array Comprehension" class="md-nav__link">
|
|
Array Comprehension
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../response/" title="Response" class="md-nav__link">
|
|
Response
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../middleware/" title="Middleware" class="md-nav__link">
|
|
Middleware
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../body/" title="Body" class="md-nav__link">
|
|
Body
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../response-representable/" title="ResponseRepresentable" class="md-nav__link">
|
|
ResponseRepresentable
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../responder/" title="Responder" class="md-nav__link">
|
|
Responder
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../client/" title="Client" class="md-nav__link">
|
|
Client
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../server/" title="Server" class="md-nav__link">
|
|
Server
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../cors/" title="CORS" class="md-nav__link">
|
|
CORS
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-15" type="checkbox" id="nav-15">
|
|
|
|
<label class="md-nav__link" for="nav-15">
|
|
Leaf
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-15">
|
|
Leaf
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../leaf/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../leaf/provider/" title="Provider" class="md-nav__link">
|
|
Provider
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../leaf/leaf/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-16" type="checkbox" id="nav-16">
|
|
|
|
<label class="md-nav__link" for="nav-16">
|
|
Validation
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-16">
|
|
Validation
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../validation/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../validation/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-17" type="checkbox" id="nav-17">
|
|
|
|
<label class="md-nav__link" for="nav-17">
|
|
Node
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-17">
|
|
Node
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../node/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../node/getting-started/" title="Getting Started" class="md-nav__link">
|
|
Getting Started
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-18" type="checkbox" id="nav-18">
|
|
|
|
<label class="md-nav__link" for="nav-18">
|
|
Core
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-18">
|
|
Core
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../core/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../core/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-19" type="checkbox" id="nav-19">
|
|
|
|
<label class="md-nav__link" for="nav-19">
|
|
Bits
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-19">
|
|
Bits
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../bits/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../bits/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-20" type="checkbox" id="nav-20">
|
|
|
|
<label class="md-nav__link" for="nav-20">
|
|
Debugging
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-20">
|
|
Debugging
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../debugging/package/" title="Package" class="md-nav__link">
|
|
Package
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../debugging/overview/" title="Overview" class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-21" type="checkbox" id="nav-21">
|
|
|
|
<label class="md-nav__link" for="nav-21">
|
|
Deploy
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-21">
|
|
Deploy
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../deploy/cloud/" title="Cloud" class="md-nav__link">
|
|
Cloud
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../deploy/nginx/" title="Nginx" class="md-nav__link">
|
|
Nginx
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../deploy/apache2/" title="Apache2" class="md-nav__link">
|
|
Apache2
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../deploy/supervisor/" title="Supervisor" class="md-nav__link">
|
|
Supervisor
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
<input class="md-toggle md-nav__toggle" data-md-toggle="nav-22" type="checkbox" id="nav-22">
|
|
|
|
<label class="md-nav__link" for="nav-22">
|
|
Version (2.0)
|
|
</label>
|
|
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
|
|
<label class="md-nav__title" for="nav-22">
|
|
Version (2.0)
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/1_5/" title="1.5" class="md-nav__link">
|
|
1.5
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/2_0/" title="2.0" class="md-nav__link">
|
|
2.0
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../../version/support/" title="Support" class="md-nav__link">
|
|
Support
|
|
</a>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
<nav class="md-nav md-nav--secondary">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="toc">Table of contents</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#method" title="Method" class="md-nav__link">
|
|
Method
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#uri" title="URI" class="md-nav__link">
|
|
URI
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#route-parameters" title="Route Parameters" class="md-nav__link">
|
|
Route Parameters
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#headers" title="Headers" class="md-nav__link">
|
|
Headers
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#extending-headers" title="Extending Headers" class="md-nav__link">
|
|
Extending Headers
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#body" title="Body" class="md-nav__link">
|
|
Body
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#content" title="Content" class="md-nav__link">
|
|
Content
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#form-data" title="Form Data" class="md-nav__link">
|
|
Form Data
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#json" title="JSON" class="md-nav__link">
|
|
JSON
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#query-parameters" title="Query Parameters" class="md-nav__link">
|
|
Query Parameters
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#key-paths" title="Key Paths" class="md-nav__link">
|
|
Key Paths
|
|
</a>
|
|
|
|
<nav class="md-nav">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#metadata" title="Metadata" class="md-nav__link">
|
|
Metadata
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#items" title="Items" class="md-nav__link">
|
|
Items
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#mixing-arrays-and-objects" title="Mixing Arrays and Objects" class="md-nav__link">
|
|
Mixing Arrays and Objects
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#array-item" title="Array Item" class="md-nav__link">
|
|
Array Item
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#array-comprehension" title="Array Comprehension" class="md-nav__link">
|
|
Array Comprehension
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
<a href="https://github.com/vapor/documentation/edit/master/2.0/docs/http/request.md" title="Edit this page" class="md-icon md-content__edit">edit</a>
|
|
|
|
|
|
|
|
<h1 id="request">Request<a class="headerlink" href="#request" title="Permanent link">¶</a></h1>
|
|
<p>The most common part of the <code>HTTP</code> library we'll be interacting with is the <code>Request</code> type. Here's a look at some of the most commonly used attributes in this type.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">public</span> <span class="kd">var</span> <span class="nv">method</span><span class="p">:</span> <span class="n">Method</span>
|
|
<span class="kd">public</span> <span class="kd">var</span> <span class="nv">uri</span><span class="p">:</span> <span class="n">URI</span>
|
|
<span class="kd">public</span> <span class="kd">var</span> <span class="nv">parameters</span><span class="p">:</span> <span class="n">Node</span>
|
|
<span class="kd">public</span> <span class="kd">var</span> <span class="nv">headers</span><span class="p">:</span> <span class="p">[</span><span class="n">HeaderKey</span><span class="p">:</span> <span class="nb">String</span><span class="p">]</span>
|
|
<span class="kd">public</span> <span class="kd">var</span> <span class="nv">body</span><span class="p">:</span> <span class="n">Body</span>
|
|
<span class="kd">public</span> <span class="kd">var</span> <span class="nv">data</span><span class="p">:</span> <span class="n">Content</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="method">Method<a class="headerlink" href="#method" title="Permanent link">¶</a></h3>
|
|
<p>The HTTP <code>Method</code> associated with the <code>Request</code>, ie: <code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>PATCH</code>, <code>DELETE</code>.</p>
|
|
<h3 id="uri">URI<a class="headerlink" href="#uri" title="Permanent link">¶</a></h3>
|
|
<p>The associated <code>URI</code> of the request. We will use this to access attributes about the <code>uri</code> the request was sent to.</p>
|
|
<p>For example, given the following uri: <code>http://vapor.codes/example?query=hi#fragments-too</code></p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">scheme</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">uri</span><span class="p">.</span><span class="n">scheme</span> <span class="c1">// http</span>
|
|
<span class="kd">let</span> <span class="nv">host</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">uri</span><span class="p">.</span><span class="n">host</span> <span class="c1">// vapor.codes</span>
|
|
|
|
<span class="kd">let</span> <span class="nv">path</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">uri</span><span class="p">.</span><span class="n">path</span> <span class="c1">// /example</span>
|
|
<span class="kd">let</span> <span class="nv">query</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">uri</span><span class="p">.</span><span class="n">query</span> <span class="c1">// query=hi</span>
|
|
<span class="kd">let</span> <span class="nv">fragment</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">uri</span><span class="p">.</span><span class="n">fragment</span> <span class="c1">// fragments-too</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="route-parameters">Route Parameters<a class="headerlink" href="#route-parameters" title="Permanent link">¶</a></h3>
|
|
<p>The url parameters associated with the request. For example, if we have a path registered as <code>hello/:name/age/:age</code>, we would be able to access those in our request, like so:</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">name</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">parameters</span><span class="p">[</span><span class="s">"name"</span><span class="p">]</span> <span class="c1">// String?</span>
|
|
<span class="kd">let</span> <span class="nv">age</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">parameters</span><span class="p">[</span><span class="s">"age"</span><span class="p">]?.</span><span class="n">int</span> <span class="c1">// Int?</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>Or, to automatically throw on <code>nil</code> or invalid variable, you can also <code>extract</code></p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">name</span> <span class="p">=</span> <span class="k">try</span> <span class="n">request</span><span class="p">.</span><span class="n">parameters</span><span class="p">.</span><span class="n">extract</span><span class="p">(</span><span class="s">"name"</span><span class="p">)</span> <span class="k">as</span> <span class="nb">String</span>
|
|
<span class="kd">let</span> <span class="nv">age</span> <span class="p">=</span> <span class="k">try</span> <span class="n">request</span><span class="p">.</span><span class="n">parameters</span><span class="p">.</span><span class="n">extract</span><span class="p">(</span><span class="s">"age"</span><span class="p">)</span> <span class="k">as</span> <span class="nb">Int</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>These extract functions can cast to any <code>NodeInitializable</code> type, including your own custom types. Make sure to check out <a href="https://github.com/vapor/node">Node</a> for more info.</p>
|
|
<blockquote>
|
|
<p>Note: Vapor also provides type safe routing in the routing section of our docs.</p>
|
|
</blockquote>
|
|
<h3 id="headers">Headers<a class="headerlink" href="#headers" title="Permanent link">¶</a></h3>
|
|
<p>These are the headers associated with the request. If you are preparing an outgoing request, this can be used to add your own keys.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">contentType</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"Content-Type"</span><span class="p">]</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>Or for outgoing requests:</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">request</span> <span class="p">=</span> <span class="n">Request</span> <span class="p">...</span>
|
|
<span class="n">request</span><span class="p">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"Content-Type"</span><span class="p">]</span> <span class="p">=</span> <span class="s">"application/json"</span>
|
|
<span class="n">request</span><span class="p">.</span><span class="n">headers</span><span class="p">[</span><span class="s">"Authorization"</span><span class="p">]</span> <span class="p">=</span> <span class="p">...</span> <span class="n">my</span> <span class="n">auth</span> <span class="n">token</span>
|
|
</pre></div>
|
|
|
|
|
|
<h4 id="extending-headers">Extending Headers<a class="headerlink" href="#extending-headers" title="Permanent link">¶</a></h4>
|
|
<p>We generally seek to improve code bases by removing stringly typed code where possible. We can add variables to the headers using generic extensions.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">extension</span> <span class="nc">HTTP</span><span class="p">.</span><span class="n">KeyAccessible</span> <span class="k">where</span> <span class="n">Key</span> <span class="p">==</span> <span class="n">HeaderKey</span><span class="p">,</span> <span class="n">Value</span> <span class="p">==</span> <span class="nb">String</span> <span class="p">{</span>
|
|
<span class="kd">var</span> <span class="nv">customKey</span><span class="p">:</span> <span class="nb">String</span><span class="p">?</span> <span class="p">{</span>
|
|
<span class="kr">get</span> <span class="p">{</span>
|
|
<span class="k">return</span> <span class="kc">self</span><span class="p">[</span><span class="s">"Custom-Key"</span><span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="kr">set</span> <span class="p">{</span>
|
|
<span class="kc">self</span><span class="p">[</span><span class="s">"Custom-Key"</span><span class="p">]</span> <span class="p">=</span> <span class="n">newValue</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>With this pattern implemented, our string <code>"Custom-Key"</code> is contained in one section of our code. We can now access like this:</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">customKey</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">headers</span><span class="p">.</span><span class="n">customKey</span>
|
|
|
|
<span class="c1">// or</span>
|
|
|
|
<span class="kd">let</span> <span class="nv">request</span> <span class="p">=</span> <span class="p">...</span>
|
|
<span class="n">request</span><span class="p">.</span><span class="n">headers</span><span class="p">.</span><span class="n">customKey</span> <span class="p">=</span> <span class="s">"my custom value"</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="body">Body<a class="headerlink" href="#body" title="Permanent link">¶</a></h3>
|
|
<p>This is the body associated with the request and represents the general data payload. You can view more about body in the associated <a href="../body/">docs</a></p>
|
|
<p>For incoming requests, we'll often pull out the associated bytes like so:</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">rawBytes</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">body</span><span class="p">.</span><span class="n">bytes</span>
|
|
</pre></div>
|
|
|
|
|
|
<h2 id="content">Content<a class="headerlink" href="#content" title="Permanent link">¶</a></h2>
|
|
<p>Generally when we're sending or receiving requests, we're using them as a way to transport content. For this, Vapor provides a convenient <code>data</code> variable associated with the request that prioritizes content in a consistent way.</p>
|
|
<p>For example, say I receive a request to <code>http://vapor.codes?hello=world</code>.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">world</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"hello"</span><span class="p">]?.</span><span class="n">string</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>This same code will work if I receive a JSON request, for example:</p>
|
|
<div class="codehilite"><pre><span></span><span class="p">{</span>
|
|
<span class="nt">"hello"</span><span class="p">:</span> <span class="s2">"world"</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>Will still be accessible through data.</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">world</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"hello"</span><span class="p">]?.</span><span class="n">string</span>
|
|
</pre></div>
|
|
|
|
|
|
<blockquote>
|
|
<p>Note: Force unwrap should never be used.</p>
|
|
</blockquote>
|
|
<p>This also applies to multi-part requests and can even be extended to new types such as XML or YAML through middleware.</p>
|
|
<p>If you'd prefer to access given types more explicitly, that's totally fine. The <code>data</code> variable is purely opt-in convenience for those who want it.</p>
|
|
<h2 id="form-data">Form Data<a class="headerlink" href="#form-data" title="Permanent link">¶</a></h2>
|
|
<p>It is common in many applications to receive forms submitted from a Web browser. Vapor provides support for several common encodings:</p>
|
|
<div class="codehilite"><pre><span></span><span class="c1">// Node? from application/x-www-form-urlencoded</span>
|
|
<span class="kd">let</span> <span class="nv">formData</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">formURLEncoded</span>
|
|
|
|
<span class="c1">// [String:Field]? from multipart/form-data</span>
|
|
<span class="kd">let</span> <span class="nv">multipartFormData</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">formData</span>
|
|
|
|
<span class="c1">// [Part]? from multipart/mixed</span>
|
|
<span class="kd">let</span> <span class="nv">multipartMixedData</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">multipart</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>These accessors will return <code>nil</code> if the request's <code>Content-Type</code> does not match what they expect.</p>
|
|
<h2 id="json">JSON<a class="headerlink" href="#json" title="Permanent link">¶</a></h2>
|
|
<p>To access JSON directly on a given request, use the following:</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">json</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">json</span><span class="p">[</span><span class="s">"hello"</span><span class="p">]</span>
|
|
</pre></div>
|
|
|
|
|
|
<h2 id="query-parameters">Query Parameters<a class="headerlink" href="#query-parameters" title="Permanent link">¶</a></h2>
|
|
<p>The same applies to query convenience:</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">query</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">query</span><span class="p">?[</span><span class="s">"hello"</span><span class="p">]</span> <span class="c1">// String?</span>
|
|
<span class="kd">let</span> <span class="nv">name</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">query</span><span class="p">?[</span><span class="s">"name"</span><span class="p">]?.</span><span class="n">string</span> <span class="c1">// String?</span>
|
|
<span class="kd">let</span> <span class="nv">age</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">query</span><span class="p">?[</span><span class="s">"age"</span><span class="p">]?.</span><span class="n">int</span> <span class="c1">// Int?</span>
|
|
<span class="kd">let</span> <span class="nv">rating</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">query</span><span class="p">?[</span><span class="s">"rating"</span><span class="p">]?.</span><span class="n">double</span> <span class="c1">// Double?</span>
|
|
</pre></div>
|
|
|
|
|
|
<h2 id="key-paths">Key Paths<a class="headerlink" href="#key-paths" title="Permanent link">¶</a></h2>
|
|
<p>Key paths work on most Vapor types that can have nested key value objects. Here's a couple examples of how to access given the following json:</p>
|
|
<div class="codehilite"><pre><span></span><span class="p">{</span>
|
|
<span class="nt">"metadata"</span><span class="p">:</span> <span class="s2">"some metadata"</span><span class="p">,</span>
|
|
<span class="nt">"artists"</span> <span class="p">:</span> <span class="p">{</span>
|
|
<span class="nt">"href"</span><span class="p">:</span> <span class="s2">"http://someurl.com"</span><span class="p">,</span>
|
|
<span class="nt">"items"</span><span class="p">:</span> <span class="p">[</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Van Gogh"</span><span class="p">,</span>
|
|
<span class="p">},</span>
|
|
<span class="p">{</span>
|
|
<span class="nt">"name"</span><span class="p">:</span> <span class="s2">"Mozart"</span>
|
|
<span class="p">}</span>
|
|
<span class="p">]</span>
|
|
<span class="p">}</span>
|
|
<span class="p">}</span>
|
|
</pre></div>
|
|
|
|
|
|
<p>We could access the data in the following ways:</p>
|
|
<h3 id="metadata">Metadata<a class="headerlink" href="#metadata" title="Permanent link">¶</a></h3>
|
|
<p>Access top level values</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">type</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"metadata"</span><span class="p">].</span><span class="n">string</span> <span class="c1">// "some metadata"</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="items">Items<a class="headerlink" href="#items" title="Permanent link">¶</a></h3>
|
|
<p>Access nested values</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">items</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"artists"</span><span class="p">,</span> <span class="s">"items"</span><span class="p">]</span> <span class="c1">// [["name": "Van Gogh"], ["name": "Mozart"]]</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="mixing-arrays-and-objects">Mixing Arrays and Objects<a class="headerlink" href="#mixing-arrays-and-objects" title="Permanent link">¶</a></h3>
|
|
<p>Get first artists</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">first</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"artists"</span><span class="p">,</span> <span class="s">"items"</span><span class="p">,</span> <span class="mi">0</span><span class="p">]</span> <span class="c1">// ["name": "Van Gogh"]</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="array-item">Array Item<a class="headerlink" href="#array-item" title="Permanent link">¶</a></h3>
|
|
<p>Get key from array item</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">firstName</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"artists"</span><span class="p">,</span> <span class="s">"items"</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="s">"name"</span><span class="p">]</span> <span class="c1">// "Van Gogh"</span>
|
|
</pre></div>
|
|
|
|
|
|
<h3 id="array-comprehension">Array Comprehension<a class="headerlink" href="#array-comprehension" title="Permanent link">¶</a></h3>
|
|
<p>We can also smartly map an array of keys, for example, to just get the names of all of the artists, we could use the following</p>
|
|
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">names</span> <span class="p">=</span> <span class="n">request</span><span class="p">.</span><span class="n">data</span><span class="p">[</span><span class="s">"artists"</span><span class="p">,</span> <span class="s">"items"</span><span class="p">,</span> <span class="s">"name"</span><span class="p">]</span> <span class="c1">// ["Van Gogh", "Mozart"]</span>
|
|
</pre></div>
|
|
|
|
|
|
</article>
|
|
</div>
|
|
</div>
|
|
</main>
|
|
|
|
|
|
<footer class="md-footer">
|
|
|
|
<div class="md-footer-nav">
|
|
<nav class="md-footer-nav__inner md-grid">
|
|
|
|
<a href="../package/" title="Package" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev">
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<i class="md-icon md-icon--arrow-back md-footer-nav__button"></i>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
|
<span class="md-flex__ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Previous
|
|
</span>
|
|
Package
|
|
</span>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
<a href="../response/" title="Response" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next">
|
|
<div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title">
|
|
<span class="md-flex__ellipsis">
|
|
<span class="md-footer-nav__direction">
|
|
Next
|
|
</span>
|
|
Response
|
|
</span>
|
|
</div>
|
|
<div class="md-flex__cell md-flex__cell--shrink">
|
|
<i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
</div>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-footer-copyright">
|
|
|
|
<div class="md-footer-copyright__highlight">
|
|
Copyright © 2017 Qutheory, LLC
|
|
</div>
|
|
|
|
powered by
|
|
<a href="http://www.mkdocs.org" title="MkDocs">MkDocs</a>
|
|
and
|
|
<a href="http://squidfunk.github.io/mkdocs-material/" title="Material for MkDocs">
|
|
Material for MkDocs</a>
|
|
</div>
|
|
|
|
|
|
<div class="md-footer-social">
|
|
|
|
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css">
|
|
|
|
<a href="https://twitter.com/@codevapor" class="md-footer-social__link fa fa-twitter"></a>
|
|
|
|
<a href="http://vapor.team/" class="md-footer-social__link fa fa-slack"></a>
|
|
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
|
|
<script src="../../assets/javascripts/application-f6cd941c96.js"></script>
|
|
<script>app.initialize({url:{base:"../.."}})</script>
|
|
|
|
|
|
|
|
|
|
<script>!function(e,t,n,a,o,c,i){e.GoogleAnalyticsObject=o,e[o]=e[o]||function(){(e[o].q=e[o].q||[]).push(arguments)},e[o].l=1*new Date,c=t.createElement(n),i=t.getElementsByTagName(n)[0],c.async=1,c.src=a,i.parentNode.insertBefore(c,i)}(window,document,"script","https://www.google-analytics.com/analytics.js","ga"),ga("create","UA-76177358-4","auto"),ga("set","anonymizeIp",!0),ga("send","pageview");var links=document.getElementsByTagName("a");Array.prototype.map.call(links,function(e){e.host!=document.location.host&&e.addEventListener("click",function(){var t=e.getAttribute("data-md-action")||"follow";ga("send","event","outbound",t,e.href)})}),document.forms.search.query.addEventListener("blur",function(){if(this.value){var e=document.location.pathname;ga("send","pageview",e+"?q="+this.value)}})</script>
|
|
|
|
|
|
</body>
|
|
</html> |