mirror
/
vapor-docs
mirror of https://github.com/vapor/docs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
vapor-docs/build/2.0/http/client/index.html

1919 lines
52 KiB
HTML
Raw Blame History

<!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.2, mkdocs-material-1.1.1">
<title>Client - 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>
Client
</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">
Settings
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-4">
Settings
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../settings/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>
</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">
Sessions
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-12">
Sessions
</label>
<ul class="md-nav__list" data-md-scrollfix>
<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-13" type="checkbox" id="nav-13" checked>
<label class="md-nav__link" for="nav-13">
HTTP
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-13">
HTTP
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../request/" title="Request" class="md-nav__link">
Request
</a>
</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 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">
Client
</label>
<a href="./" title="Client" class="md-nav__link md-nav__link--active">
Client
</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="#quickstart" title="QuickStart" class="md-nav__link">
QuickStart
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#clean-up" title="Clean Up" class="md-nav__link">
Clean Up
</a>
</li>
<li class="md-nav__item">
<a href="#continued" title="Continued" class="md-nav__link">
Continued
</a>
</li>
<li class="md-nav__item">
<a href="#post-as-json" title="POST as json" class="md-nav__link">
POST as json
</a>
</li>
<li class="md-nav__item">
<a href="#post-as-x-www-form-urlencoded" title="POST as x-www-form-urlencoded" class="md-nav__link">
POST as x-www-form-urlencoded
</a>
</li>
<li class="md-nav__item">
<a href="#full-request" title="Full Request" class="md-nav__link">
Full Request
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#config" title="Config" class="md-nav__link">
Config
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#tls" title="TLS" class="md-nav__link">
TLS
</a>
</li>
<li class="md-nav__item">
<a href="#mozilla" title="Mozilla" class="md-nav__link">
Mozilla
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#advanced" title="Advanced" class="md-nav__link">
Advanced
</a>
</li>
<li class="md-nav__item">
<a href="#save-connection" title="Save Connection" class="md-nav__link">
Save Connection
</a>
</li>
<li class="md-nav__item">
<a href="#clientprotocol" title="ClientProtocol" class="md-nav__link">
ClientProtocol
</a>
</li>
<li class="md-nav__item">
<a href="#customize-droplet" title="Customize Droplet" class="md-nav__link">
Customize Droplet
</a>
</li>
</ul>
</nav>
</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-14" type="checkbox" id="nav-14">
<label class="md-nav__link" for="nav-14">
Leaf
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-14">
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">
<a href="../../validation/overview/" title="Validation" class="md-nav__link">
Validation
</a>
</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">
Node
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-16">
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>
</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">
Core
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-17">
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-18" type="checkbox" id="nav-18">
<label class="md-nav__link" for="nav-18">
Bits
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-18">
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-19" type="checkbox" id="nav-19">
<label class="md-nav__link" for="nav-19">
Debugging
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-19">
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-20" type="checkbox" id="nav-20">
<label class="md-nav__link" for="nav-20">
Advanced
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-20">
Advanced
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../advanced/modules/" title="Modules" class="md-nav__link">
Modules
</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">
Version (2.0)
</label>
<nav class="md-nav" data-md-component="collapsible" data-md-level="1">
<label class="md-nav__title" for="nav-21">
Version (2.0)
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../switch/1_5/" title="1.5" class="md-nav__link">
1.5
</a>
</li>
<li class="md-nav__item">
<a href="../../switch/2_0/" title="2.0" class="md-nav__link">
2.0
</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="#quickstart" title="QuickStart" class="md-nav__link">
QuickStart
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#clean-up" title="Clean Up" class="md-nav__link">
Clean Up
</a>
</li>
<li class="md-nav__item">
<a href="#continued" title="Continued" class="md-nav__link">
Continued
</a>
</li>
<li class="md-nav__item">
<a href="#post-as-json" title="POST as json" class="md-nav__link">
POST as json
</a>
</li>
<li class="md-nav__item">
<a href="#post-as-x-www-form-urlencoded" title="POST as x-www-form-urlencoded" class="md-nav__link">
POST as x-www-form-urlencoded
</a>
</li>
<li class="md-nav__item">
<a href="#full-request" title="Full Request" class="md-nav__link">
Full Request
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#config" title="Config" class="md-nav__link">
Config
</a>
<nav class="md-nav">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#tls" title="TLS" class="md-nav__link">
TLS
</a>
</li>
<li class="md-nav__item">
<a href="#mozilla" title="Mozilla" class="md-nav__link">
Mozilla
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#advanced" title="Advanced" class="md-nav__link">
Advanced
</a>
</li>
<li class="md-nav__item">
<a href="#save-connection" title="Save Connection" class="md-nav__link">
Save Connection
</a>
</li>
<li class="md-nav__item">
<a href="#clientprotocol" title="ClientProtocol" class="md-nav__link">
ClientProtocol
</a>
</li>
<li class="md-nav__item">
<a href="#customize-droplet" title="Customize Droplet" class="md-nav__link">
Customize Droplet
</a>
</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/client.md" title="Edit this page" class="md-icon md-content__edit">edit</a>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This section may contain outdated information.</p>
</div>
<blockquote>
<p>Module: <code>import HTTP</code></p>
</blockquote>
<h1 id="client">Client<a class="headerlink" href="#client" title="Permanent link">&para;</a></h1>
<p>The client provided by <code>HTTP</code> is used to make outgoing requests to remote servers. Let's look at a simple outgoing request.</p>
<h2 id="quickstart">QuickStart<a class="headerlink" href="#quickstart" title="Permanent link">&para;</a></h2>
<p>Let's jump right in to make a simple HTTP Request. Here's a basic <code>GET</code> request using your Vapor <code>Droplet</code>.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">query</span> <span class="p">=</span> <span class="p">...</span>
<span class="kd">let</span> <span class="nv">spotifyResponse</span> <span class="p">=</span> <span class="k">try</span> <span class="n">drop</span><span class="p">.</span><span class="n">client</span><span class="p">.</span><span class="kr">get</span><span class="p">(</span><span class="s">&quot;https://api.spotify.com/v1/search?type=artist&amp;q=</span><span class="si">\(</span><span class="n">query</span><span class="si">)</span><span class="s">&quot;</span><span class="p">)</span>
<span class="bp">print</span><span class="p">(</span><span class="n">spotifyR</span><span class="p">)</span>
</pre></div>
<h3 id="clean-up">Clean Up<a class="headerlink" href="#clean-up" title="Permanent link">&para;</a></h3>
<p>The url above can be a little tricky to read, so let's use the query parameter to clean it up a little bit:</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">drop</span><span class="p">.</span><span class="n">client</span><span class="p">.</span><span class="kr">get</span><span class="p">(</span><span class="s">&quot;https://api.spotify.com/v1/search&quot;</span><span class="p">,</span> <span class="n">query</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;type&quot;</span><span class="p">:</span> <span class="s">&quot;artist&quot;</span><span class="p">,</span> <span class="s">&quot;q&quot;</span><span class="p">:</span> <span class="n">query</span><span class="p">])</span>
</pre></div>
<h3 id="continued">Continued<a class="headerlink" href="#continued" title="Permanent link">&para;</a></h3>
<p>In addition to <code>GET</code> requests, Vapor's client provides support for most common HTTP functions. <code>GET</code>, <code>POST</code>, <code>PUT</code>, <code>PATCH</code>, <code>DELETE</code></p>
<h3 id="post-as-json">POST as json<a class="headerlink" href="#post-as-json" title="Permanent link">&para;</a></h3>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">drop</span><span class="p">.</span><span class="n">client</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">&quot;http://some-endpoint/json&quot;</span><span class="p">,</span> <span class="n">headers</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;Content-Type&quot;</span><span class="p">:</span> <span class="s">&quot;application/json&quot;</span><span class="p">],</span> <span class="n">body</span><span class="p">:</span> <span class="n">myJSON</span><span class="p">.</span><span class="n">makeBody</span><span class="p">())</span>
</pre></div>
<h3 id="post-as-x-www-form-urlencoded">POST as x-www-form-urlencoded<a class="headerlink" href="#post-as-x-www-form-urlencoded" title="Permanent link">&para;</a></h3>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">drop</span><span class="p">.</span><span class="n">client</span><span class="p">.</span><span class="n">post</span><span class="p">(</span><span class="s">&quot;http://some-endpoint&quot;</span><span class="p">,</span> <span class="n">headers</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;Content-Type&quot;</span><span class="p">:</span> <span class="s">&quot;application/x-www-form-urlencoded&quot;</span>
<span class="p">],</span> <span class="n">body</span><span class="p">:</span> <span class="n">Body</span><span class="p">.</span><span class="n">data</span><span class="p">(</span> <span class="n">Node</span><span class="p">(</span><span class="n">node</span><span class="p">:</span> <span class="p">[</span>
<span class="s">&quot;email&quot;</span><span class="p">:</span> <span class="s">&quot;mymail@vapor.codes&quot;</span>
<span class="p">]).</span><span class="n">formURLEncoded</span><span class="p">()))</span>
</pre></div>
<h3 id="full-request">Full Request<a class="headerlink" href="#full-request" title="Permanent link">&para;</a></h3>
<p>To access additional functionality or custom methods, use the underlying <code>request</code> function directly.</p>
<div class="codehilite"><pre><span></span><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">get</span><span class="p">(</span><span class="kc">_</span> <span class="n">method</span><span class="p">:</span> <span class="n">Method</span><span class="p">,</span>
<span class="kc">_</span> <span class="n">uri</span><span class="p">:</span> <span class="nb">String</span><span class="p">,</span>
<span class="n">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="p">=</span> <span class="p">[:],</span>
<span class="n">query</span><span class="p">:</span> <span class="p">[</span><span class="nb">String</span><span class="p">:</span> <span class="n">CustomStringConvertible</span><span class="p">]</span> <span class="p">=</span> <span class="p">[:],</span>
<span class="n">body</span><span class="p">:</span> <span class="n">Body</span> <span class="p">=</span> <span class="p">[])</span> <span class="kr">throws</span> <span class="p">-&gt;</span> <span class="n">Response</span>
</pre></div>
<p>For example:</p>
<div class="codehilite"><pre><span></span><span class="k">try</span> <span class="n">drop</span><span class="p">.</span><span class="n">client</span><span class="p">.</span><span class="n">request</span><span class="p">(.</span><span class="n">other</span><span class="p">(</span><span class="n">method</span><span class="p">:</span> <span class="s">&quot;CUSTOM&quot;</span><span class="p">),</span> <span class="s">&quot;http://some-domain&quot;</span><span class="p">,</span> <span class="n">headers</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;My&quot;</span><span class="p">:</span> <span class="s">&quot;Header&quot;</span><span class="p">],</span> <span class="n">query</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;key&quot;</span><span class="p">:</span> <span class="s">&quot;value&quot;</span><span class="p">],</span> <span class="n">body</span><span class="p">:</span> <span class="p">[])</span>
</pre></div>
<h2 id="config">Config<a class="headerlink" href="#config" title="Permanent link">&para;</a></h2>
<p>The <code>Config/clients.json</code> file can be used to modify the client's settings.</p>
<h3 id="tls">TLS<a class="headerlink" href="#tls" title="Permanent link">&para;</a></h3>
<p>Host and certificate verification can be disabled.</p>
<blockquote>
<p>Note: Use extreme caution when modifying these settings.</p>
</blockquote>
<div class="codehilite"><pre><span></span><span class="p">{</span>
<span class="nt">&quot;tls&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">&quot;verifyHost&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
<span class="nt">&quot;verifyCertificates&quot;</span><span class="p">:</span> <span class="kc">false</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<h3 id="mozilla">Mozilla<a class="headerlink" href="#mozilla" title="Permanent link">&para;</a></h3>
<p>The Mozilla certificates are included by default to make fetching content from secure sites easy.</p>
<div class="codehilite"><pre><span></span><span class="p">{</span>
<span class="nt">&quot;tls&quot;</span><span class="p">:</span> <span class="p">{</span>
<span class="nt">&quot;certificates&quot;</span><span class="p">:</span> <span class="s2">&quot;mozilla&quot;</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
<h2 id="advanced">Advanced<a class="headerlink" href="#advanced" title="Permanent link">&para;</a></h2>
<p>In addition to our Droplet, we can also use and interact with the <code>Client</code> manually. Here's how our default implementation in Vapor looks:</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">response</span> <span class="p">=</span> <span class="k">try</span> <span class="n">Client</span><span class="p">&lt;</span><span class="n">TCPClientStream</span><span class="p">&gt;.</span><span class="kr">get</span><span class="p">(</span><span class="s">&quot;http://some-endpoint/mine&quot;</span><span class="p">)</span>
</pre></div>
<p>The first thing we likely noticed is <code>TCPClientStream</code> being used as a Generic value. This will be the underlying connection that the <code>HTTP.Client</code> can use when performing the request. By conforming to the underlying <code>ClientStream</code>, an <code>HTTP.Client</code> can accept custom stream implementations seamlessly.</p>
<h2 id="save-connection">Save Connection<a class="headerlink" href="#save-connection" title="Permanent link">&para;</a></h2>
<p>Up to this point, we've been interacting with the Client via <code>class</code> or <code>static</code> level functions. This allows us to end the connection upon a completed request and is the recommended interaction for most use cases. For some advanced situations, we may want to reuse a connection. For these, we can initialize our client and perform multiple requests like this.</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">pokemonClient</span> <span class="p">=</span> <span class="k">try</span> <span class="n">drop</span><span class="p">?.</span><span class="n">client</span><span class="p">.</span><span class="n">make</span><span class="p">(</span><span class="n">scheme</span><span class="p">:</span> <span class="s">&quot;http&quot;</span><span class="p">,</span> <span class="n">host</span><span class="p">:</span> <span class="s">&quot;pokeapi.co&quot;</span><span class="p">)</span>
<span class="k">for</span> <span class="n">i</span> <span class="k">in</span> <span class="mf">0.</span><span class="p">..</span><span class="mi">1</span> <span class="p">{</span>
<span class="kd">let</span> <span class="nv">response</span> <span class="p">=</span> <span class="k">try</span> <span class="n">pokemonClient</span><span class="p">?.</span><span class="kr">get</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="s">&quot;/api/v2/pokemon/&quot;</span><span class="p">,</span> <span class="n">query</span><span class="p">:</span> <span class="p">[</span><span class="s">&quot;limit&quot;</span><span class="p">:</span> <span class="mi">20</span><span class="p">,</span> <span class="s">&quot;offset&quot;</span><span class="p">:</span> <span class="n">i</span><span class="p">])</span>
<span class="bp">print</span><span class="p">(</span><span class="s">&quot;response: </span><span class="si">\(</span><span class="n">response</span><span class="si">)</span><span class="s">&quot;</span><span class="p">)</span>
<span class="p">}</span>
</pre></div>
<h2 id="clientprotocol">ClientProtocol<a class="headerlink" href="#clientprotocol" title="Permanent link">&para;</a></h2>
<p>Up to this point, we've focused on the built in <code>HTTP.Client</code>, but users can also include their own customized clients by conforming to <code>HTTP.ClientProtocol</code>. Let's look at the implementation:</p>
<div class="codehilite"><pre><span></span><span class="kd">public</span> <span class="kd">protocol</span> <span class="nc">Responder</span> <span class="p">{</span>
<span class="kd">func</span> <span class="nf">respond</span><span class="p">(</span><span class="n">to</span> <span class="n">request</span><span class="p">:</span> <span class="n">Request</span><span class="p">)</span> <span class="kr">throws</span> <span class="p">-&gt;</span> <span class="n">Response</span>
<span class="p">}</span>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="nc">Program</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nv">host</span><span class="p">:</span> <span class="nb">String</span> <span class="p">{</span> <span class="kr">get</span> <span class="p">}</span>
<span class="kd">var</span> <span class="nv">port</span><span class="p">:</span> <span class="nb">Int</span> <span class="p">{</span> <span class="kr">get</span> <span class="p">}</span>
<span class="kd">var</span> <span class="nv">securityLayer</span><span class="p">:</span> <span class="n">SecurityLayer</span> <span class="p">{</span> <span class="kr">get</span> <span class="p">}</span>
<span class="c1">// default implemented</span>
<span class="kd">init</span><span class="p">(</span><span class="n">host</span><span class="p">:</span> <span class="nb">String</span><span class="p">,</span> <span class="n">port</span><span class="p">:</span> <span class="nb">Int</span><span class="p">,</span> <span class="n">securityLayer</span><span class="p">:</span> <span class="n">SecurityLayer</span><span class="p">)</span> <span class="kr">throws</span>
<span class="p">}</span>
<span class="kd">public</span> <span class="kd">protocol</span> <span class="nc">ClientProtocol</span><span class="p">:</span> <span class="n">Program</span><span class="p">,</span> <span class="n">Responder</span> <span class="p">{</span>
<span class="kd">var</span> <span class="nv">scheme</span><span class="p">:</span> <span class="nb">String</span> <span class="p">{</span> <span class="kr">get</span> <span class="p">}</span>
<span class="kd">var</span> <span class="nv">stream</span><span class="p">:</span> <span class="n">Stream</span> <span class="p">{</span> <span class="kr">get</span> <span class="p">}</span>
<span class="kd">init</span><span class="p">(</span><span class="n">scheme</span><span class="p">:</span> <span class="nb">String</span><span class="p">,</span> <span class="n">host</span><span class="p">:</span> <span class="nb">String</span><span class="p">,</span> <span class="n">port</span><span class="p">:</span> <span class="nb">Int</span><span class="p">,</span> <span class="n">securityLayer</span><span class="p">:</span> <span class="n">SecurityLayer</span><span class="p">)</span> <span class="kr">throws</span>
<span class="p">}</span>
</pre></div>
<p>By conforming to these underlying functions, we immediately gain access to the public <code>ClientProtocol</code> apis we viewed above.</p>
<h2 id="customize-droplet">Customize Droplet<a class="headerlink" href="#customize-droplet" title="Permanent link">&para;</a></h2>
<p>If we've introduced a custom conformance to <code>HTTP.ClientProtocol</code>, we can pass this into our droplet without changing the underlying behavior in our application.</p>
<p>For example:</p>
<div class="codehilite"><pre><span></span><span class="kd">let</span> <span class="nv">drop</span> <span class="p">=</span> <span class="n">Droplet</span><span class="p">()</span>
<span class="n">drop</span><span class="p">.</span><span class="n">client</span> <span class="p">=</span> <span class="n">MyCustomClient</span><span class="p">.</span><span class="kc">self</span>
</pre></div>
<p>Going forward, all of your calls to <code>drop.client</code> will use <code>MyCustomClient.self</code>:</p>
<div class="codehilite"><pre><span></span><span class="n">drop</span><span class="p">.</span><span class="n">client</span><span class="p">.</span><span class="kr">get</span><span class="p">(...</span> <span class="c1">// uses `MyCustomClient`</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="../responder/" title="Responder" 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>
Responder
</span>
</div>
</a>
<a href="../server/" title="Server" 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>
Server
</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 &copy; 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>
Reference in New Issue View Git Blame Copy Permalink