endpoints.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Endpoints  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset='utf-8'>
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
  </head>
  <body>
    <a title="Endpoints  Reference"></a>
    <header>
      <div class="content-wrapper">
        <p><a href="index.html">Moya Docs</a> (82% documented)</p>
      </div>
    </header>
    <div class="content-wrapper">
      <p id="breadcrumbs">
        <a href="index.html">Moya Reference</a>
        <img id="carat" src="img/carat.png" />
        Endpoints  Reference
      </p>
    </div>
    <div class="content-wrapper">
      <nav class="sidebar">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a href="Guides.html">Guides</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="authentication.html">Authentication</a>
              </li>
              <li class="nav-group-task">
                <a href="communityprojects.html">CommunityProjects</a>
              </li>
              <li class="nav-group-task">
                <a href="endpoints.html">Endpoints</a>
              </li>
              <li class="nav-group-task">
                <a href="plugins.html">Plugins</a>
              </li>
              <li class="nav-group-task">
                <a href="providers.html">Providers</a>
              </li>
              <li class="nav-group-task">
                <a href="readme.html">README</a>
              </li>
              <li class="nav-group-task">
                <a href="reactiveswift.html">ReactiveSwift</a>
              </li>
              <li class="nav-group-task">
                <a href="releasing.html">Releasing</a>
              </li>
              <li class="nav-group-task">
                <a href="rxswift.html">RxSwift</a>
              </li>
              <li class="nav-group-task">
                <a href="targets.html">Targets</a>
              </li>
              <li class="nav-group-task">
                <a href="testing.html">Testing</a>
              </li>
              <li class="nav-group-task">
                <a href="threading.html">Threading</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Classes/CancellableToken.html">CancellableToken</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/CredentialsPlugin.html">CredentialsPlugin</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Endpoint.html">Endpoint</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/MoyaProvider.html">MoyaProvider</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/NetworkActivityPlugin.html">NetworkActivityPlugin</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/NetworkLoggerPlugin.html">NetworkLoggerPlugin</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/NetworkLoggerPlugin/Configuration.html">– Configuration</a>
              </li>
              <li class="nav-group-task">
                <a href="Classes/Response.html">Response</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Enums/AuthorizationType.html">AuthorizationType</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/EndpointSampleResponse.html">EndpointSampleResponse</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/MoyaError.html">MoyaError</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/MultiTarget.html">MultiTarget</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/NetworkActivityChangeType.html">NetworkActivityChangeType</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/StubBehavior.html">StubBehavior</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/Task.html">Task</a>
              </li>
              <li class="nav-group-task">
                <a href="Enums/ValidationType.html">ValidationType</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Extensions/Method.html">Method</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/Request.html">Request</a>
              </li>
              <li class="nav-group-task">
                <a href="Extensions/URL.html">URL</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Functions.html">Functions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Functions.html#/s:4Moya23convertResponseToResult_7request4data5errors0E0OyAA0C0CAA0A5ErrorOGSo17NSHTTPURLResponseCSg_10Foundation10URLRequestVSgAP4DataVSgs0I0_pSgtF">convertResponseToResult(_:request:data:error:)</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Protocols/AccessTokenAuthorizable.html">AccessTokenAuthorizable</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/Cancellable.html">Cancellable</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/MoyaProviderType.html">MoyaProviderType</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/PluginType.html">PluginType</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/RequestType.html">RequestType</a>
              </li>
              <li class="nav-group-task">
                <a href="Protocols/TargetType.html">TargetType</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Structs/AccessTokenPlugin.html">AccessTokenPlugin</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/MultipartFormData.html">MultipartFormData</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/MultipartFormData/FormDataProvider.html">– FormDataProvider</a>
              </li>
              <li class="nav-group-task">
                <a href="Structs/ProgressResponse.html">ProgressResponse</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a href="Typealiases.html">Type Aliases</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya10Completiona">Completion</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya19DownloadDestinationa">DownloadDestination</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya5Imagea">Image</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/ImageType">ImageType</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya9ImageTypea">ImageType</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya12JSONEncodinga">JSONEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya6Methoda">Method</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya17ParameterEncodinga">ParameterEncoding</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya13ProgressBlocka">ProgressBlock</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya18RequestInterceptora">RequestInterceptor</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya24RequestMultipartFormDataa">RequestMultipartFormData</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya7Sessiona">Session</a>
              </li>
              <li class="nav-group-task">
                <a href="Typealiases.html#/s:4Moya11URLEncodinga">URLEncoding</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">
        <section>
          <section class="section">
            
            <h1 id='endpoints' class='heading'>Endpoints</h1>

<p>An endpoint is a semi-internal data structure that Moya uses to reason about
the network request that will ultimately be made. An endpoint stores the
following data:</p>

<ul>
<li>The url.</li>
<li>The HTTP method (<code>GET</code>, <code>POST</code>, etc).</li>
<li>The HTTP request header fields.</li>
<li><code><a href="Enums/Task.html">Task</a></code> to differentiate <code>upload</code>, <code>download</code> or <code>request</code>.</li>
<li>The sample response (for unit testing).</li>
</ul>

<p><a href="Providers.md">Providers</a> map <a href="Targets.md">Targets</a> to Endpoints, then map
Endpoints to actual network requests.</p>

<p>There are two ways that you interact with Endpoints.</p>

<ol>
<li>When creating a provider, you may specify a mapping from <code>Target</code> to <code><a href="Classes/Endpoint.html">Endpoint</a></code>.</li>
<li>When creating a provider, you may specify a mapping from <code><a href="Classes/Endpoint.html">Endpoint</a></code> to <code>URLRequest</code>.</li>
</ol>

<p>The first might resemble the following:</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">endpointClosure</span> <span class="o">=</span> <span class="p">{</span> <span class="p">(</span><span class="nv">target</span><span class="p">:</span> <span class="kt">MyTarget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Endpoint</span> <span class="k">in</span>
    <span class="k">let</span> <span class="nv">url</span> <span class="o">=</span> <span class="kt">URL</span><span class="p">(</span><span class="nv">target</span><span class="p">:</span> <span class="n">target</span><span class="p">)</span><span class="o">.</span><span class="n">absoluteString</span>
    <span class="k">return</span> <span class="kt">Endpoint</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="n">url</span><span class="p">,</span> <span class="nv">sampleResponseClosure</span><span class="p">:</span> <span class="p">{</span><span class="o">.</span><span class="nf">networkResponse</span><span class="p">(</span><span class="mi">200</span><span class="p">,</span> <span class="n">target</span><span class="o">.</span><span class="n">sampleData</span><span class="p">)},</span> <span class="nv">method</span><span class="p">:</span> <span class="n">target</span><span class="o">.</span><span class="n">method</span><span class="p">,</span> <span class="nv">task</span><span class="p">:</span> <span class="n">target</span><span class="o">.</span><span class="n">task</span><span class="p">,</span> <span class="nv">httpHeaderFields</span><span class="p">:</span> <span class="n">target</span><span class="o">.</span><span class="n">headers</span><span class="p">)</span>
<span class="p">}</span>
</code></pre>

<p>This is actually the default implementation Moya provides. If you need something
custom, or if you&rsquo;re creating a test provider that returns non-200 HTTP statuses in unit tests,
this is where you would do it.</p>

<p>Notice the <code>URL(target:)</code> initializer, Moya provides a convenient extension to create a <code>URL</code> from any <code><a href="Protocols/TargetType.html">TargetType</a></code>.</p>

<p>The second use is very uncommon. Moya tries to prevent you from having to worry
about low-level details. But it&rsquo;s there if you need it. Its use is covered
further below.</p>

<p>Let&rsquo;s take a look at an example of the flexibility mapping from a Target to
an Endpoint can provide.</p>
<h2 id='from-target-to-endpoint' class='heading'>From Target to Endpoint</h2>

<p>In this closure you have absolute power over converting from <code>Target</code> to <code><a href="Classes/Endpoint.html">Endpoint</a></code>.
You can change the <code>task</code>, <code>method</code>, <code>url</code>, <code>headers</code> or <code>sampleResponse</code>.
For example, we may wish to set our application name in the HTTP header fields for server-side
analytics.</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">endpointClosure</span> <span class="o">=</span> <span class="p">{</span> <span class="p">(</span><span class="nv">target</span><span class="p">:</span> <span class="kt">MyTarget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Endpoint</span> <span class="k">in</span>
    <span class="k">let</span> <span class="nv">defaultEndpoint</span> <span class="o">=</span> <span class="kt">MoyaProvider</span><span class="o">.</span><span class="nf">defaultEndpointMapping</span><span class="p">(</span><span class="nv">for</span><span class="p">:</span> <span class="n">target</span><span class="p">)</span>
    <span class="k">return</span> <span class="n">defaultEndpoint</span><span class="o">.</span><span class="nf">adding</span><span class="p">(</span><span class="nv">newHTTPHeaderFields</span><span class="p">:</span> <span class="p">[</span><span class="s">"APP_NAME"</span><span class="p">:</span> <span class="s">"MY_AWESOME_APP"</span><span class="p">])</span>
<span class="p">}</span>
<span class="k">let</span> <span class="nv">provider</span> <span class="o">=</span> <span class="kt">MoyaProvider</span><span class="o">&lt;</span><span class="kt">GitHub</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">endpointClosure</span><span class="p">:</span> <span class="n">endpointClosure</span><span class="p">)</span>
</code></pre>

<p><em>Note that header fields can also be added as part of the <a href="Targets.md">Target</a> definition.</em></p>

<p>This also means that you can provide additional parameters to some or all of
your endpoints. For example, say that there is an authentication token we need
for all values of the hypothetical <code>MyTarget</code> target, with the exception of the
target that actually does the authentication. We could construct an
<code>endpointClosure</code> resembling the following.</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">endpointClosure</span> <span class="o">=</span> <span class="p">{</span> <span class="p">(</span><span class="nv">target</span><span class="p">:</span> <span class="kt">MyTarget</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Endpoint</span> <span class="k">in</span>
    <span class="k">let</span> <span class="nv">defaultEndpoint</span> <span class="o">=</span> <span class="kt">MoyaProvider</span><span class="o">.</span><span class="nf">defaultEndpointMapping</span><span class="p">(</span><span class="nv">for</span><span class="p">:</span> <span class="n">target</span><span class="p">)</span>

    <span class="c1">// Sign all non-authenticating requests</span>
    <span class="k">switch</span> <span class="n">target</span> <span class="p">{</span>
    <span class="k">case</span> <span class="o">.</span><span class="nv">authenticate</span><span class="p">:</span>
        <span class="k">return</span> <span class="n">defaultEndpoint</span>
    <span class="k">default</span><span class="p">:</span>
        <span class="k">return</span> <span class="n">defaultEndpoint</span><span class="o">.</span><span class="nf">adding</span><span class="p">(</span><span class="nv">newHTTPHeaderFields</span><span class="p">:</span> <span class="p">[</span><span class="s">"AUTHENTICATION_TOKEN"</span><span class="p">:</span> <span class="kt">GlobalAppStorage</span><span class="o">.</span><span class="n">authToken</span><span class="p">])</span>
    <span class="p">}</span>
<span class="p">}</span>
<span class="k">let</span> <span class="nv">provider</span> <span class="o">=</span> <span class="kt">MoyaProvider</span><span class="o">&lt;</span><span class="kt">GitHub</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">endpointClosure</span><span class="p">:</span> <span class="n">endpointClosure</span><span class="p">)</span>
</code></pre>

<p>Awesome.</p>

<p>Note that we can rely on the existing behavior of Moya and extend – instead
of replace – it. The <code>adding(newHttpHeaderFields:)</code> function allows you to
rely on the existing Moya code and add your own custom values.</p>

<p>Sample responses are a requirement of the <code><a href="Protocols/TargetType.html">TargetType</a></code> protocol. However, they
only specify the data returned. The Target-to-Endpoint mapping closure is where
you can specify more details, which is useful for unit testing.</p>

<p>Sample responses have one of these values:</p>

<ul>
<li><code>.networkError(NSError)</code> when network failed to send the request, or failed to retrieve a response (eg a timeout).</li>
<li><code>.networkResponse(Int, Data)</code> where <code>Int</code> is a status code and <code>Data</code> is the returned data.</li>
<li><code>.response(HTTPURLResponse, Data)</code> where <code>HTTPURLResponse</code> is the response and <code>Data</code> is the returned data. This one can be used to fully stub a response.</li>
</ul>
<h2 id='request-mapping' class='heading'>Request Mapping</h2>

<p>As we mentioned earlier, the purpose of this library is not really to provide a
coding framework with which to access the network – that&rsquo;s Alamofire&rsquo;s job.
Instead, Moya is about a way to frame your thoughts about network access and
provide compile-time checking of well-defined network targets. You&rsquo;ve already
seen how to map targets into endpoints using the <code>endpointClosure</code> parameter
of the <code><a href="Classes/MoyaProvider.html">MoyaProvider</a></code> initializer. That lets you create an <code><a href="Classes/Endpoint.html">Endpoint</a></code> instance
that Moya will use to reason about the network API call. At some point, that
<code><a href="Classes/Endpoint.html">Endpoint</a></code> must be resolved into an actual <code>URLRequest</code> to give to Alamofire.
That&rsquo;s what the <code>requestClosure</code> parameter is for.</p>

<p>The <code>requestClosure</code> is an optional, last-minute way to modify the request
that hits the network. It has a default value of <code>MoyaProvider.defaultRequestMapping</code>,
which uses the <code>urlRequest()</code> method of the <code><a href="Classes/Endpoint.html">Endpoint</a></code> instance. This <code>urlRequest()</code> 
method throws three possible errors: </p>

<ul>
<li><code>MoyaError.requestMapping(String)</code> when <code>URLRequest</code> could not be created for given path</li>
<li><code>MoyaError.parameterEncoding(Swift.Error)</code> when parameters couldn&rsquo;t be encoded</li>
<li><code>MoyaError.encodableMapping(Swift.Error)</code> when <code>Encodable</code> object couldn&rsquo;t be encoded into <code>Data</code></li>
</ul>

<p>This closure receives an <code><a href="Classes/Endpoint.html">Endpoint</a></code> instance and is responsible for invoking a
its argument of <code>RequestResultClosure</code> (shorthand for <code>Result&lt;URLRequest, MoyaError&gt; -&gt; Void</code>) with a request that represents the Endpoint.
It&rsquo;s here that you&rsquo;d do your OAuth signing or whatever. Since you may invoke the
closure asynchronously, you can use whatever authentication library you like (<a href="https://github.com/rheinfabrik/Heimdallr.swift">example</a>).
Instead of modifying the request, you could simply log it, instead.</p>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">requestClosure</span> <span class="o">=</span> <span class="p">{</span> <span class="p">(</span><span class="nv">endpoint</span><span class="p">:</span> <span class="kt">Endpoint</span><span class="p">,</span> <span class="nv">done</span><span class="p">:</span> <span class="kt">MoyaProvider</span><span class="o">.</span><span class="kt">RequestResultClosure</span><span class="p">)</span> <span class="k">in</span>
    <span class="k">do</span> <span class="p">{</span>
        <span class="k">var</span> <span class="nv">request</span> <span class="o">=</span> <span class="k">try</span> <span class="n">endpoint</span><span class="o">.</span><span class="nf">urlRequest</span><span class="p">()</span>
        <span class="c1">// Modify the request however you like.</span>
        <span class="nf">done</span><span class="p">(</span><span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>
    <span class="p">}</span> <span class="k">catch</span> <span class="p">{</span>
        <span class="nf">done</span><span class="p">(</span><span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="kt">MoyaError</span><span class="o">.</span><span class="nf">underlying</span><span class="p">(</span><span class="n">error</span><span class="p">)))</span>
    <span class="p">}</span>

<span class="p">}</span>
<span class="k">let</span> <span class="nv">provider</span> <span class="o">=</span> <span class="kt">MoyaProvider</span><span class="o">&lt;</span><span class="kt">GitHub</span><span class="o">&gt;</span><span class="p">(</span><span class="nv">requestClosure</span><span class="p">:</span> <span class="n">requestClosure</span><span class="p">)</span>
</code></pre>

<p>This <code>requestClosure</code> is useful for modifying properties specific to the <code>URLRequest</code> or providing information to the request that cannot be known until that request is created, like cookies settings. Note that the <code>endpointClosure</code> mentioned above is not intended for this purpose or any request-specific application-level mapping.</p>

<p>This parameter is actually very useful for modifying the request object.
<code>URLRequest</code> has many properties you can customize. Say you want to disable
all cookies on requests:</p>
<pre class="highlight swift"><code><span class="p">{</span> <span class="p">(</span><span class="nv">endpoint</span><span class="p">:</span> <span class="kt">Endpoint</span><span class="p">,</span> <span class="nv">done</span><span class="p">:</span> <span class="kt">MoyaProvider</span><span class="o">.</span><span class="kt">RequestResultClosure</span><span class="p">)</span> <span class="k">in</span>
    <span class="k">do</span> <span class="p">{</span>
        <span class="k">var</span> <span class="nv">request</span><span class="p">:</span> <span class="kt">URLRequest</span> <span class="o">=</span> <span class="k">try</span> <span class="n">endpoint</span><span class="o">.</span><span class="nf">urlRequest</span><span class="p">()</span>
        <span class="n">request</span><span class="o">.</span><span class="n">httpShouldHandleCookies</span> <span class="o">=</span> <span class="kc">false</span>
        <span class="nf">done</span><span class="p">(</span><span class="o">.</span><span class="nf">success</span><span class="p">(</span><span class="n">request</span><span class="p">))</span>
    <span class="p">}</span> <span class="k">catch</span> <span class="p">{</span>
        <span class="nf">done</span><span class="p">(</span><span class="o">.</span><span class="nf">failure</span><span class="p">(</span><span class="kt">MoyaError</span><span class="o">.</span><span class="nf">underlying</span><span class="p">(</span><span class="n">error</span><span class="p">)))</span>
    <span class="p">}</span>
<span class="p">}</span>
</code></pre>

<p>You could also perform logging of network requests, since this closure is
invoked just before the request is sent to the network.</p>

          </section>
        </section>
        <section id="footer">
          <p>&copy; 2020 <a class="link" href="https://github.com/Moya/Moya" target="_blank" rel="external">Ash Furrow</a>. All rights reserved. (Last updated: 2020-02-24)</p>
          <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
        </section>
      </article>
    </div>
  </body>
</div>
</html>