github.com/System-Glitch/goyave/v2@v2.10.3-0.20200819142921-51011e75d504/docs/guide/basics/responses.html (about)

     1  <!DOCTYPE html>
     2  <html lang="en-US">
     3    <head>
     4      <meta charset="utf-8">
     5      <meta name="viewport" content="width=device-width,initial-scale=1">
     6      <title>Responses | Goyave</title>
     7      <meta name="generator" content="VuePress 1.5.3">
     8      <link rel="icon" type="image/png" sizes="16x16" href="/goyave/goyave_16.png">
     9      <link rel="icon" type="image/png" sizes="32x32" href="/goyave/goyave_32.png">
    10      <link rel="icon" type="image/png" sizes="64x64" href="/goyave/goyave_64.png">
    11      <link rel="icon" type="image/png" sizes="128x128" href="/goyave/goyave_128.png">
    12      <link rel="icon" type="image/png" sizes="256x256" href="/goyave/goyave_256.png">
    13      <link rel="icon" type="image/png" sizes="512x512" href="/goyave/goyave_512.png">
    14      <meta name="description" content="Goyave is a Golang web API framework aiming at cleanliness, fast development and power.">
    15      <meta name="og:title" content="Responses - Goyave">
    16      <meta name="twitter:title" content="Responses - Goyave">
    17      <meta name="title" content="Responses - Goyave">
    18      <meta property="twitter:description" content="Goyave is a Golang web API framework aiming at cleanliness, fast development and power.">
    19      <meta property="twitter:image:src" content="https://system-glitch.github.io/goyave/goyave_banner.png">
    20      <meta property="twitter:card" content="summary_large_image">
    21      <meta property="og:type" content="website">
    22      <meta property="og:description" content="Goyave is a Golang web API framework aiming at cleanliness, fast development and power.">
    23      <meta property="og:image" content="https://system-glitch.github.io/goyave/goyave_banner.png">
    24      <meta property="og:site_name" content="Goyave">
    25      <link rel="preload" href="/goyave/assets/css/0.styles.589fd562.css" as="style"><link rel="preload" href="/goyave/assets/js/app.092490a7.js" as="script"><link rel="preload" href="/goyave/assets/js/4.75a9cc68.js" as="script"><link rel="preload" href="/goyave/assets/js/1.121dd9ed.js" as="script"><link rel="preload" href="/goyave/assets/js/21.c3fd6053.js" as="script"><link rel="preload" href="/goyave/assets/js/5.c83f1192.js" as="script"><link rel="prefetch" href="/goyave/assets/js/10.2f07bbf5.js"><link rel="prefetch" href="/goyave/assets/js/11.2d66fdef.js"><link rel="prefetch" href="/goyave/assets/js/12.63171b15.js"><link rel="prefetch" href="/goyave/assets/js/13.770050f3.js"><link rel="prefetch" href="/goyave/assets/js/14.b933d8cf.js"><link rel="prefetch" href="/goyave/assets/js/15.36df2a66.js"><link rel="prefetch" href="/goyave/assets/js/16.ed66719e.js"><link rel="prefetch" href="/goyave/assets/js/17.7bef5f05.js"><link rel="prefetch" href="/goyave/assets/js/18.470b55ed.js"><link rel="prefetch" href="/goyave/assets/js/19.90e0dab8.js"><link rel="prefetch" href="/goyave/assets/js/20.3a300ca3.js"><link rel="prefetch" href="/goyave/assets/js/22.d5569617.js"><link rel="prefetch" href="/goyave/assets/js/23.931b2034.js"><link rel="prefetch" href="/goyave/assets/js/24.1a4755e7.js"><link rel="prefetch" href="/goyave/assets/js/25.0d463913.js"><link rel="prefetch" href="/goyave/assets/js/26.3c173a7a.js"><link rel="prefetch" href="/goyave/assets/js/27.9c5b36f2.js"><link rel="prefetch" href="/goyave/assets/js/28.41e055b7.js"><link rel="prefetch" href="/goyave/assets/js/29.b87adf4a.js"><link rel="prefetch" href="/goyave/assets/js/3.ef71e77d.js"><link rel="prefetch" href="/goyave/assets/js/6.2336bf0c.js"><link rel="prefetch" href="/goyave/assets/js/7.d60e55c1.js"><link rel="prefetch" href="/goyave/assets/js/8.2ee33a42.js"><link rel="prefetch" href="/goyave/assets/js/9.8e043d60.js">
    26      <link rel="stylesheet" href="/goyave/assets/css/0.styles.589fd562.css">
    27    </head>
    28    <body>
    29      <div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/goyave/" class="home-link router-link-active"><img src="/goyave/goyave_64.png" alt="Goyave" class="logo"> <span class="site-name can-hide">Goyave</span></a> <div class="links"><div class="user-settings"><a title="Dark theme" href="#" class="settings-button"><svg aria-hidden="true" data-prefix="fas" data-icon="cog" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" class="svg-inline--fa fa-cog fa-w-16 settings-icon"><path fill="currentColor" d="M8 0c-4.4 0-8 3.6-8 8s3.6 8 8 8 8-3.6 8-8-3.6-8-8-8zM8 15c-3.9 0-7-3.1-7-7 0-2.4 1.2-4.6 3.2-5.9-0.1 0.6-0.2 1.3-0.2 1.9 0 4.9 4 8.9 8.9 9-1.3 1.3-3 2-4.9 2z"></path></svg></a></div> <div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/goyave/guide/" class="nav-link router-link-active">
    30    Guide
    31  </a></div><div class="nav-item"><a href="https://pkg.go.dev/github.com/System-Glitch/goyave/v2" target="_blank" rel="noopener noreferrer" class="nav-link external">
    32    pkg.go.dev
    33    <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <a href="https://github.com/System-Glitch/goyave" target="_blank" rel="noopener noreferrer" class="repo-link">
    34      GitHub
    35      <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/goyave/guide/" class="nav-link router-link-active">
    36    Guide
    37  </a></div><div class="nav-item"><a href="https://pkg.go.dev/github.com/System-Glitch/goyave/v2" target="_blank" rel="noopener noreferrer" class="nav-link external">
    38    pkg.go.dev
    39    <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <a href="https://github.com/System-Glitch/goyave" target="_blank" rel="noopener noreferrer" class="repo-link">
    40      GitHub
    41      <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></nav>  <ul class="sidebar-links"><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Guide</span> <span class="arrow right"></span></p> <!----></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading open"><span>The Basics</span> <span class="arrow down"></span></p> <ul class="sidebar-links sidebar-group-items"><li><a href="/goyave/guide/basics/routing.html" class="sidebar-link">Routing</a></li><li><a href="/goyave/guide/basics/middleware.html" class="sidebar-link">Middleware</a></li><li><a href="/goyave/guide/basics/requests.html" class="sidebar-link">Requests</a></li><li><a href="/goyave/guide/basics/controllers.html" class="sidebar-link">Controllers</a></li><li><a href="/goyave/guide/basics/responses.html" aria-current="page" class="active sidebar-link">Responses</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/goyave/guide/basics/responses.html#introduction" class="sidebar-link">Introduction</a></li><li class="sidebar-sub-header"><a href="/goyave/guide/basics/responses.html#reference" class="sidebar-link">Reference</a></li><li class="sidebar-sub-header"><a href="/goyave/guide/basics/responses.html#chained-writers" class="sidebar-link">Chained writers</a></li></ul></li><li><a href="/goyave/guide/basics/database.html" class="sidebar-link">Database</a></li><li><a href="/goyave/guide/basics/validation.html" class="sidebar-link">Validation</a></li></ul></section></li><li><section class="sidebar-group collapsable depth-0"><p class="sidebar-heading"><span>Advanced</span> <span class="arrow right"></span></p> <!----></section></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="responses"><a href="#responses" class="header-anchor">#</a> Responses</h1> <p></p><div class="table-of-contents"><ul><li><a href="#introduction">Introduction</a></li><li><a href="#reference">Reference</a></li><li><a href="#chained-writers">Chained writers</a></li></ul></div><p></p> <h2 id="introduction"><a href="#introduction" class="header-anchor">#</a> Introduction</h2> <p>Handlers receive a <code>goyave.Response</code> and a <code>goyave.Request</code> as parameters.</p> <p><code>goyave.Response</code> implements <code>http.ResponseWriter</code>. This object brings a number of convenient methods to write HTTP responses.</p> <p>If you didn't write anything before the request lifecycle ends, <code>204 No Content</code> is automatically written.</p> <h2 id="reference"><a href="#reference" class="header-anchor">#</a> Reference</h2> <p>All functions below require the <code>goyave</code> package to be imported.</p> <div class="language-go extra-class"><pre class="language-go"><code><span class="token keyword">import</span> <span class="token string">&quot;github.com/System-Glitch/goyave/v2&quot;</span>
    42  </code></pre></div><p><strong>List of response methods</strong>:</p> <div class="table"><p><a href="#response-getstatus">GetStatus</a> <a href="#response-geterror">GetError</a> <a href="#response-header">Header</a> <a href="#response-status">Status</a> <a href="#response-json">JSON</a> <a href="#response-string">String</a> <a href="#response-write">Write</a> <a href="#response-file">File</a> <a href="#response-download">Download</a> <a href="#response-error">Error</a> <a href="#response-cookie">Cookie</a> <a href="#response-redirect">Redirect</a> <a href="#response-temporaryredirect">TemporaryRedirect</a> <a href="#response-render">Render</a> <a href="#response-renderhtml">RenderHTML</a> <a href="#response-handledatabaseerror">HandleDatabaseError</a></p></div><h4 id="response-getstatus"><a href="#response-getstatus" class="header-anchor">#</a> Response.GetStatus</h4> <p>Returns the response code for this request or <code>0</code> if not yet set.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td></td> <td><code>int</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>fmt<span class="token punctuation">.</span><span class="token function">Println</span><span class="token punctuation">(</span>response<span class="token punctuation">.</span><span class="token function">GetStatus</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token comment">// 200</span>
    43  </code></pre></div><h4 id="response-geterror"><a href="#response-geterror" class="header-anchor">#</a> Response.GetError</h4> <p>Returns the value which caused a panic in the request's handling, or <code>nil</code>. The response error is also set when <a href="#response-error"><code>Error()</code></a> is called.</p> <p>This method is mainly used in <a href="/goyave/guide/advanced/status-handlers.html">status handlers</a>.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td></td> <td><code>interface{}</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>fmt<span class="token punctuation">.</span><span class="token function">Println</span><span class="token punctuation">(</span>response<span class="token punctuation">.</span><span class="token function">GetError</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token comment">// &quot;panic: something wrong happened&quot;</span>
    44  </code></pre></div><h4 id="response-header"><a href="#response-header" class="header-anchor">#</a> Response.Header</h4> <p>Returns the Header map that will be sent.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td></td> <td><code>http.Header</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>header <span class="token operator">:=</span> response<span class="token punctuation">.</span><span class="token function">Header</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
    45  header<span class="token punctuation">.</span><span class="token function">Set</span><span class="token punctuation">(</span><span class="token string">&quot;Content-Type&quot;</span><span class="token punctuation">,</span> <span class="token string">&quot;application/json&quot;</span><span class="token punctuation">)</span>
    46  </code></pre></div><h4 id="response-status"><a href="#response-status" class="header-anchor">#</a> Response.Status</h4> <p>Write the given status code. Calling this method a second time will have no effect.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>status int</code></td> <td><code>void</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">Status</span><span class="token punctuation">(</span>http<span class="token punctuation">.</span>StatusOK<span class="token punctuation">)</span>
    47  </code></pre></div><h4 id="response-json"><a href="#response-json" class="header-anchor">#</a> Response.JSON</h4> <p>Write JSON data as a response. This method automatically sets the <code>Content-Type</code> header.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>responseCode int</code></td> <td><code>error</code></td></tr> <tr><td><code>data interface{}</code></td> <td></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">JSON</span><span class="token punctuation">(</span>http<span class="token punctuation">.</span>StatusOK<span class="token punctuation">,</span> <span class="token keyword">map</span><span class="token punctuation">[</span><span class="token builtin">string</span><span class="token punctuation">]</span><span class="token keyword">interface</span><span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">{</span>
    48      <span class="token string">&quot;name&quot;</span><span class="token punctuation">:</span> <span class="token string">&quot;John Doe&quot;</span><span class="token punctuation">,</span>
    49      <span class="token string">&quot;tags&quot;</span><span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token builtin">string</span><span class="token punctuation">{</span><span class="token string">&quot;tag1&quot;</span><span class="token punctuation">,</span> <span class="token string">&quot;tag2&quot;</span><span class="token punctuation">}</span><span class="token punctuation">,</span>
    50  <span class="token punctuation">}</span><span class="token punctuation">)</span>
    51  </code></pre></div><h4 id="response-string"><a href="#response-string" class="header-anchor">#</a> Response.String</h4> <p>Write a string as a response.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>responseCode int</code></td> <td><code>error</code></td></tr> <tr><td><code>message string</code></td> <td></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">String</span><span class="token punctuation">(</span>http<span class="token punctuation">.</span>StatusOK<span class="token punctuation">,</span> <span class="token string">&quot;Hello there!&quot;</span><span class="token punctuation">)</span>
    52  </code></pre></div><h4 id="response-write"><a href="#response-write" class="header-anchor">#</a> Response.Write</h4> <p>Write the data as a response. Can be used to write in-memory files. This method can be called successively.</p> <p>Returns the number of bytes written.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>data []byte</code></td> <td><code>int</code></td></tr> <tr><td></td> <td><code>error</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">Write</span><span class="token punctuation">(</span><span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token function">byte</span><span class="token punctuation">(</span><span class="token string">&quot;Hello there!&quot;</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
    53  </code></pre></div><h4 id="response-file"><a href="#response-file" class="header-anchor">#</a> Response.File</h4> <p>Write a file as an inline element.</p> <p>Automatically detects the file MIME type and sets the &quot;Content-Type&quot; header accordingly. If the file doesn't exist, respond with status <code>404 Not Found</code>. The given path can be relative or absolute.</p> <p>If you want the file to be sent as a download (&quot;Content-Disposition: attachment&quot;), use the <code>Download</code> function instead.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>file string</code></td> <td><code>error</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">File</span><span class="token punctuation">(</span><span class="token string">&quot;/path/to/file&quot;</span><span class="token punctuation">)</span>
    54  </code></pre></div><h4 id="response-download"><a href="#response-download" class="header-anchor">#</a> Response.Download</h4> <p>Write a file as an attachment element.</p> <p>Automatically detects the file MIME type and sets the &quot;Content-Type&quot; header accordingly. If the file doesn't exist, respond with status <code>404 Not Found</code>. The given path can be relative or absolute.</p> <p>The <code>fileName</code> parameter defines the name the client will see. In other words, it sets the header &quot;Content-Disposition&quot; to &quot;attachment; filename=&quot;${fileName}&quot;&quot;</p> <p>If you want the file to be sent as an inline element (&quot;Content-Disposition: inline&quot;), use the <code>File</code> function instead.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>file string</code></td> <td><code>error</code></td></tr> <tr><td><code>fileName string</code></td> <td></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">Download</span><span class="token punctuation">(</span><span class="token string">&quot;/path/to/file&quot;</span><span class="token punctuation">,</span> <span class="token string">&quot;awesome.txt&quot;</span><span class="token punctuation">)</span>
    55  </code></pre></div><h4 id="response-error"><a href="#response-error" class="header-anchor">#</a> Response.Error</h4> <p>Print the error in the console and return it with an error code <code>500</code>.</p> <p>If debugging is enabled in the config, the error is also written in the response using the JSON format, and the stacktrace is printed in the console. If debugging is not enabled, only the stauts code is set, which means you can still write to the response, or use your error <a href="/goyave/guide/advanced/status-handlers.html">status handler</a>.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>err interface{}</code></td> <td><code>error</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>v<span class="token punctuation">,</span> err <span class="token operator">:=</span> strconv<span class="token punctuation">.</span><span class="token function">Atoi</span><span class="token punctuation">(</span><span class="token string">&quot;-42&quot;</span><span class="token punctuation">)</span>
    56  response<span class="token punctuation">.</span><span class="token function">Error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
    57  </code></pre></div><h4 id="response-cookie"><a href="#response-cookie" class="header-anchor">#</a> Response.Cookie</h4> <p>Add a Set-Cookie header to the response. The provided cookie must have a valid Name. Invalid cookies may be silently dropped.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>cookie *http.Cookie*</code></td> <td><code>void</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>cookie <span class="token operator">:=</span> <span class="token operator">&amp;</span>http<span class="token punctuation">.</span>Cookie<span class="token punctuation">{</span>
    58      Name<span class="token punctuation">:</span>  <span class="token string">&quot;cookie-name&quot;</span><span class="token punctuation">,</span>
    59      Value<span class="token punctuation">:</span> <span class="token string">&quot;value&quot;</span><span class="token punctuation">,</span>
    60  <span class="token punctuation">}</span>
    61  response<span class="token punctuation">.</span><span class="token function">Cookie</span><span class="token punctuation">(</span>cookie<span class="token punctuation">)</span>
    62  </code></pre></div><div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p>Protect yourself from <a href="https://en.wikipedia.org/wiki/Cross-site_request_forgery" target="_blank" rel="noopener noreferrer">CSRF attacks<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a> when using cookies!</p></div> <h4 id="response-redirect"><a href="#response-redirect" class="header-anchor">#</a> Response.Redirect</h4> <p>Send a permanent redirect response. (HTTP 308)</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>url string</code></td> <td><code>void</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">Redirect</span><span class="token punctuation">(</span><span class="token string">&quot;/login&quot;</span><span class="token punctuation">)</span>
    63  </code></pre></div><h4 id="response-temporaryredirect"><a href="#response-temporaryredirect" class="header-anchor">#</a> Response.TemporaryRedirect</h4> <p>Send a temporary redirect response. (HTTP 307)</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>url string</code></td> <td><code>void</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>response<span class="token punctuation">.</span><span class="token function">TemporaryRedirect</span><span class="token punctuation">(</span><span class="token string">&quot;/maintenance&quot;</span><span class="token punctuation">)</span>
    64  </code></pre></div><h4 id="response-render"><a href="#response-render" class="header-anchor">#</a> Response.Render</h4> <p>Render a text template with the given data. This method uses the <a href="https://golang.org/pkg/text/template/" target="_blank" rel="noopener noreferrer">Go's template API<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</p> <p>The template path is relative to the <code>resources/template</code> directory.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>responseCode int</code></td> <td><code>error</code></td></tr> <tr><td><code>templatePath string</code></td> <td></td></tr> <tr><td><code>data interface{}</code></td> <td></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code><span class="token keyword">type</span> Inventory <span class="token keyword">struct</span> <span class="token punctuation">{</span>
    65  	Material <span class="token builtin">string</span>
    66  	Count    <span class="token builtin">uint</span>
    67  <span class="token punctuation">}</span>
    68  
    69  sweaters <span class="token operator">:=</span> Inventory<span class="token punctuation">{</span><span class="token string">&quot;wool&quot;</span><span class="token punctuation">,</span> <span class="token number">17</span><span class="token punctuation">}</span>
    70  
    71  <span class="token comment">// data can also be a map[string]interface{}</span>
    72  <span class="token comment">// Here, &quot;resources/template/template.txt&quot; will be used.</span>
    73  <span class="token keyword">if</span> err <span class="token operator">:=</span> response<span class="token punctuation">.</span><span class="token function">Render</span><span class="token punctuation">(</span>http<span class="token punctuation">.</span>StatusOK<span class="token punctuation">,</span> <span class="token string">&quot;template.txt&quot;</span><span class="token punctuation">,</span> sweaters<span class="token punctuation">)</span><span class="token punctuation">;</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
    74  	response<span class="token punctuation">.</span><span class="token function">Error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
    75  <span class="token punctuation">}</span>
    76  </code></pre></div><h4 id="response-renderhtml"><a href="#response-renderhtml" class="header-anchor">#</a> Response.RenderHTML</h4> <p>Render an HTML template with the given data. This method uses the <a href="https://golang.org/pkg/html/template/" target="_blank" rel="noopener noreferrer">Go's template API<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a>.</p> <p>The template path is relative to the <code>resources/template</code> directory.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>responseCode int</code></td> <td><code>error</code></td></tr> <tr><td><code>templatePath string</code></td> <td></td></tr> <tr><td><code>data interface{}</code></td> <td></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code><span class="token keyword">type</span> Inventory <span class="token keyword">struct</span> <span class="token punctuation">{</span>
    77  	Material <span class="token builtin">string</span>
    78  	Count    <span class="token builtin">uint</span>
    79  <span class="token punctuation">}</span>
    80  
    81  sweaters <span class="token operator">:=</span> Inventory<span class="token punctuation">{</span><span class="token string">&quot;wool&quot;</span><span class="token punctuation">,</span> <span class="token number">17</span><span class="token punctuation">}</span>
    82  
    83  <span class="token comment">// data can also be a map[string]interface{}</span>
    84  <span class="token comment">// Here, &quot;resources/template/inventory.html&quot; will be used.</span>
    85  <span class="token keyword">if</span> err <span class="token operator">:=</span> response<span class="token punctuation">.</span><span class="token function">RenderHTML</span><span class="token punctuation">(</span>http<span class="token punctuation">.</span>StatusOK<span class="token punctuation">,</span> <span class="token string">&quot;inventory.html&quot;</span><span class="token punctuation">,</span> sweaters<span class="token punctuation">)</span><span class="token punctuation">;</span> err <span class="token operator">!=</span> <span class="token boolean">nil</span> <span class="token punctuation">{</span>
    86  	response<span class="token punctuation">.</span><span class="token function">Error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span>
    87  <span class="token punctuation">}</span>
    88  </code></pre></div><h4 id="response-handledatabaseerror"><a href="#response-handledatabaseerror" class="header-anchor">#</a> Response.HandleDatabaseError</h4> <p>Takes a database query result and checks if any error has occurred.</p> <p>Automatically writes HTTP status code 404 Not Found if the error is a &quot;Not found&quot; error. Calls <code>Response.Error()</code> if there is another type of error.</p> <p>Returns <code>true</code> if there is no error.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>db *gorm.DB</code></td> <td><code>bool</code></td></tr></tbody></table> <p><strong>Example:</strong></p> <div class="language-go extra-class"><pre class="language-go"><code>product <span class="token operator">:=</span> model<span class="token punctuation">.</span>Product<span class="token punctuation">{</span><span class="token punctuation">}</span>
    89  result <span class="token operator">:=</span> database<span class="token punctuation">.</span><span class="token function">GetConnection</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">First</span><span class="token punctuation">(</span><span class="token operator">&amp;</span>product<span class="token punctuation">,</span> id<span class="token punctuation">)</span>
    90  <span class="token keyword">if</span> response<span class="token punctuation">.</span><span class="token function">HandleDatabaseError</span><span class="token punctuation">(</span>result<span class="token punctuation">)</span> <span class="token punctuation">{</span>
    91      response<span class="token punctuation">.</span><span class="token function">JSON</span><span class="token punctuation">(</span>http<span class="token punctuation">.</span>StatusOK<span class="token punctuation">,</span> product<span class="token punctuation">)</span>
    92  <span class="token punctuation">}</span>
    93  </code></pre></div><h2 id="chained-writers"><a href="#chained-writers" class="header-anchor">#</a> Chained writers</h2> <p><span class="badge tip" style="vertical-align:top;" data-v-15b7b770>Since v2.7.0</span></p> <p>It is possible to replace the <code>io.Writer</code> used by the <code>Response</code> object. This allows for more flexibility when manipulating the data you send to the client. It makes it easier to compress your response, write it to logs, etc. You can chain as many writers as you want. The writer replacement is most often done in a middleware. If your writer implements <code>io.Closer</code>, it will be automatically closed at the end of the request's lifecycle.</p> <p>The following example is a simple implementation of a middleware logging everything sent by the server to the client.</p> <div class="language-go extra-class"><pre class="language-go"><code><span class="token keyword">import</span> <span class="token punctuation">(</span>
    94  	<span class="token string">&quot;io&quot;</span>
    95  	<span class="token string">&quot;log&quot;</span>
    96  
    97  	<span class="token string">&quot;github.com/System-Glitch/goyave/v2&quot;</span>
    98  <span class="token punctuation">)</span>
    99  
   100  <span class="token keyword">type</span> LogWriter <span class="token keyword">struct</span> <span class="token punctuation">{</span>
   101  	writer   io<span class="token punctuation">.</span>Writer
   102  	response <span class="token operator">*</span>goyave<span class="token punctuation">.</span>Response
   103  	body     <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token builtin">byte</span>
   104  <span class="token punctuation">}</span>
   105  
   106  <span class="token keyword">func</span> <span class="token punctuation">(</span>w <span class="token operator">*</span>LogWriter<span class="token punctuation">)</span> <span class="token function">Write</span><span class="token punctuation">(</span>b <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token builtin">byte</span><span class="token punctuation">)</span> <span class="token punctuation">(</span><span class="token builtin">int</span><span class="token punctuation">,</span> <span class="token builtin">error</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
   107  	w<span class="token punctuation">.</span>body <span class="token operator">=</span> <span class="token function">append</span><span class="token punctuation">(</span>w<span class="token punctuation">.</span>body<span class="token punctuation">,</span> b<span class="token operator">...</span><span class="token punctuation">)</span>
   108  	<span class="token keyword">return</span> w<span class="token punctuation">.</span>writer<span class="token punctuation">.</span><span class="token function">Write</span><span class="token punctuation">(</span>b<span class="token punctuation">)</span>
   109  <span class="token punctuation">}</span>
   110  
   111  <span class="token keyword">func</span> <span class="token punctuation">(</span>w <span class="token operator">*</span>LogWriter<span class="token punctuation">)</span> <span class="token function">Close</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token builtin">error</span> <span class="token punctuation">{</span>
   112      <span class="token comment">// The chained writer MUST be closed if it's closeable.</span>
   113  	<span class="token comment">// Therefore, all chained writers should implement io.Closer.</span>
   114  
   115  	goyave<span class="token punctuation">.</span>Logger<span class="token punctuation">.</span><span class="token function">Println</span><span class="token punctuation">(</span><span class="token string">&quot;RESPONSE&quot;</span><span class="token punctuation">,</span> w<span class="token punctuation">.</span>response<span class="token punctuation">.</span><span class="token function">GetStatus</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span> <span class="token function">string</span><span class="token punctuation">(</span>w<span class="token punctuation">.</span>body<span class="token punctuation">)</span><span class="token punctuation">)</span>
   116  
   117  	<span class="token keyword">if</span> wr<span class="token punctuation">,</span> ok <span class="token operator">:=</span> w<span class="token punctuation">.</span>writer<span class="token punctuation">.</span><span class="token punctuation">(</span>io<span class="token punctuation">.</span>Closer<span class="token punctuation">)</span><span class="token punctuation">;</span> ok <span class="token punctuation">{</span>
   118  		<span class="token keyword">return</span> wr<span class="token punctuation">.</span><span class="token function">Close</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
   119  	<span class="token punctuation">}</span>
   120  	<span class="token keyword">return</span> <span class="token boolean">nil</span>
   121  <span class="token punctuation">}</span>
   122  
   123  <span class="token keyword">func</span> <span class="token function">LogMiddleware</span><span class="token punctuation">(</span>next goyave<span class="token punctuation">.</span>Handler<span class="token punctuation">)</span> goyave<span class="token punctuation">.</span>Handler <span class="token punctuation">{</span>
   124  	<span class="token keyword">return</span> <span class="token keyword">func</span><span class="token punctuation">(</span>response <span class="token operator">*</span>goyave<span class="token punctuation">.</span>Response<span class="token punctuation">,</span> request <span class="token operator">*</span>goyave<span class="token punctuation">.</span>Request<span class="token punctuation">)</span> <span class="token punctuation">{</span>
   125  		logWriter <span class="token operator">:=</span> <span class="token operator">&amp;</span>LogWriter<span class="token punctuation">{</span>
   126  			writer<span class="token punctuation">:</span>   response<span class="token punctuation">.</span><span class="token function">Writer</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
   127  			response<span class="token punctuation">:</span> response<span class="token punctuation">,</span>
   128  		<span class="token punctuation">}</span>
   129  		response<span class="token punctuation">.</span><span class="token function">SetWriter</span><span class="token punctuation">(</span>logWriter<span class="token punctuation">)</span>
   130  
   131  		<span class="token function">next</span><span class="token punctuation">(</span>response<span class="token punctuation">,</span> request<span class="token punctuation">)</span>
   132  	<span class="token punctuation">}</span>
   133  <span class="token punctuation">}</span>
   134  </code></pre></div><h4 id="response-writer"><a href="#response-writer" class="header-anchor">#</a> Response.Writer</h4> <p>Return the current writer used to write the response.</p> <p>Note that the returned writer is not necessarily a <code>http.ResponseWriter</code>, as it can be replaced using <code>SetWriter</code>.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td></td> <td><code>io.Writer</code></td></tr></tbody></table> <h4 id="response-setwriter"><a href="#response-setwriter" class="header-anchor">#</a> Response.SetWriter</h4> <p>Set the writer used to write the response.</p> <p>This can be used to chain writers, for example to enable gzip compression, or for logging. The original <code>http.ResponseWriter</code> is always kept.</p> <table><thead><tr><th>Parameters</th> <th>Return</th></tr></thead> <tbody><tr><td><code>writer io.Writer</code></td> <td></td></tr></tbody></table></div> <footer class="page-edit"><div class="edit-link"><a href="https://github.com/System-Glitch/goyave/edit/master/docs_src/src/guide/basics/responses.md" target="_blank" rel="noopener noreferrer">Edit this page on GitHub</a> <svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></div> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev">
   135        ←
   136        <a href="/goyave/guide/basics/controllers.html" class="prev">
   137          Controllers
   138        </a></span> <span class="next"><a href="/goyave/guide/basics/database.html">
   139          Database
   140        </a>
   141        →
   142      </span></p></div> </main></div><div class="global-ui"><!----></div></div>
   143      <script src="/goyave/assets/js/app.092490a7.js" defer></script><script src="/goyave/assets/js/4.75a9cc68.js" defer></script><script src="/goyave/assets/js/1.121dd9ed.js" defer></script><script src="/goyave/assets/js/21.c3fd6053.js" defer></script><script src="/goyave/assets/js/5.c83f1192.js" defer></script>
   144    </body>
   145  </html>