mirror of
https://github.com/mcuadros/ascode
synced 2025-11-16 05:17:13 +01:00
10 lines
15 KiB
HTML
10 lines
15 KiB
HTML
<!doctype html><html lang=en><head><meta charset=utf-8><meta http-equiv=x-ua-compatible content="ie=edge"><title>http - AsCode - Terraform Alternative Syntax</title><meta name=viewport content="width=device-width,initial-scale=1"><link rel=icon href=https://ascode.run/images/favicon.png><link rel=stylesheet href=/css/style.min.df49831c6872564dff31a5f0978a9571f2c8110b513d4b3b1fc8ead41dcdc9f0.css></head><body class="page page-default-single"><div id=main-menu-mobile class=main-menu-mobile><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><div class=wrapper><div class=header><div class=container><div class=logo><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div class=logo-mobile><a href=https://ascode.run><img alt=Logo src=/images/logo-header.svg></a></div><div id=main-menu class=main-menu><ul><li class=menu-item-home><a href=/><span>Home</span></a></li><li class=menu-item-docs><a href=/docs/><span>Docs</span></a></li><li class=menu-item-github><a href=https://github.com/mcuadros/ascode><span>GitHub</span></a></li></ul></div><button id=toggle-main-menu-mobile class="hamburger hamburger--slider" type=button>
|
|
<span class=hamburger-box><span class=hamburger-inner></span></span></button></div></div><div class="main container pt-2 pt-md-6 pb-3 pb-md-6"><div class=row><div class="col-12 col-md-3 mb-3"><div class=sidebar><div class=docs-menu><h4><a href=/docs/reference/>API Reference</a></h4><ul><li><a href=/docs/reference/types/>built-in</a></li><li><a href=/docs/reference/docker/>docker</a></li><li><a href=/docs/reference/base64/>encoding/base64</a></li><li><a href=/docs/reference/csv/>encoding/csv</a></li><li><a href=/docs/reference/json/>encoding/json</a></li><li><a href=/docs/reference/yaml/>encoding/yaml</a></li><li><a class=active href=/docs/reference/http/>http</a></li><li><a href=/docs/reference/math/>math</a></li><li><a href=/docs/reference/os/>os</a></li><li><a href=/docs/reference/filepath/>path/filepath</a></li><li><a href=/docs/reference/re/>re</a></li><li><a href=/docs/reference/time/>time</a></li><li><a href=/docs/reference/url/>url</a></li></ul></div><div style=font-size:90%;margin-top:40px><a href=/docs/>« Documentation</a></div></div></div><div class="col-12 col-md-9"><h1 class=title>http</h1><div class=content><h2 id=index>Index</h2><div class=toc><nav id=TableOfContents><ul><li><a href=#overview>Overview</a></li><li><a href=#functions>Functions</a><ul><li><a href=#def-bdeleteb>def <b>delete</b></a></li><li><a href=#def-bgetb>def <b>get</b></a></li><li><a href=#def-boptionsb>def <b>options</b></a></li><li><a href=#def-bpatchb>def <b>patch</b></a></li><li><a href=#def-bpostb>def <b>post</b></a></li><li><a href=#def-bputb>def <b>put</b></a></li></ul></li><li><a href=#types>Types</a><ul><li><a href=#type-bresponseb>type <b>response</b></a></li></ul></li></ul></nav></div><h2 id=overview>Overview</h2><p>http defines an HTTP client implementation</p><h2 id=functions>Functions</h2><h3 id=def-bdeleteb>def <b>delete</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nb>delete</span><span class=p>(</span><span class=nx>url</span><span class=p>,</span><span class=nx>params</span><span class=p>={},</span><span class=nx>headers</span><span class=p>={},</span><span class=nx>body</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>form_body</span><span class=p>={},</span><span class=nx>form_encoding</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>json_body</span><span class=p>={},</span><span class=nx>auth</span><span class=p>=())</span> <span class=nx>response</span>
|
|
</code></pre></div><p>perform an HTTP DELETE request, returning a response</p><h6 id=arguments>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>url to request</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>optional. dictionary of headers to add to request</td></tr><tr><td><code>body</code></td><td><code>string</code></td><td>optional. raw string body to provide to the request</td></tr><tr><td><code>form_body</code></td><td><code>dict</code></td><td>optional. dict of values that will be encoded as form data</td></tr><tr><td><code>form_encoding</code></td><td><code>string</code></td><td>optional. <code>application/x-www-form-url-encoded</code> (default) or <code>multipart/form-data</code></td></tr><tr><td><code>json_body</code></td><td><code>any</code></td><td>optional. json data to supply as a request. handy for working with JSON-API’s</td></tr><tr><td><code>auth</code></td><td><code>tuple</code></td><td>optional. (username,password) tuple for http basic authorization</td></tr></tbody></table><h3 id=def-bgetb>def <b>get</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>get</span><span class=p>(</span><span class=nx>url</span><span class=p>,</span><span class=nx>params</span><span class=p>={},</span><span class=nx>headers</span><span class=p>={},</span><span class=nx>auth</span><span class=p>=())</span> <span class=nx>response</span>
|
|
</code></pre></div><p>perform an HTTP GET request, returning a response</p><h6 id=arguments-1>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>url to request</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>optional. dictionary of headers to add to request</td></tr><tr><td><code>auth</code></td><td><code>tuple</code></td><td>optional. (username,password) tuple for http basic authorization</td></tr></tbody></table><h3 id=def-boptionsb>def <b>options</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>options</span><span class=p>(</span><span class=nx>url</span><span class=p>,</span><span class=nx>params</span><span class=p>={},</span><span class=nx>headers</span><span class=p>={},</span><span class=nx>body</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>form_body</span><span class=p>={},</span><span class=nx>form_encoding</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>json_body</span><span class=p>={},</span><span class=nx>auth</span><span class=p>=())</span> <span class=nx>response</span>
|
|
</code></pre></div><p>perform an HTTP OPTIONS request, returning a response</p><h6 id=arguments-2>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>url to request</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>optional. dictionary of headers to add to request</td></tr><tr><td><code>body</code></td><td><code>string</code></td><td>optional. raw string body to provide to the request</td></tr><tr><td><code>form_body</code></td><td><code>dict</code></td><td>optional. dict of values that will be encoded as form data</td></tr><tr><td><code>form_encoding</code></td><td><code>string</code></td><td>optional. <code>application/x-www-form-url-encoded</code> (default) or <code>multipart/form-data</code></td></tr><tr><td><code>json_body</code></td><td><code>any</code></td><td>optional. json data to supply as a request. handy for working with JSON-API’s</td></tr><tr><td><code>auth</code></td><td><code>tuple</code></td><td>optional. (username,password) tuple for http basic authorization</td></tr></tbody></table><h3 id=def-bpatchb>def <b>patch</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>patch</span><span class=p>(</span><span class=nx>url</span><span class=p>,</span><span class=nx>params</span><span class=p>={},</span><span class=nx>headers</span><span class=p>={},</span><span class=nx>body</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>form_body</span><span class=p>={},</span><span class=nx>form_encoding</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>json_body</span><span class=p>={},</span><span class=nx>auth</span><span class=p>=())</span> <span class=nx>response</span>
|
|
</code></pre></div><p>perform an HTTP PATCH request, returning a response</p><h6 id=arguments-3>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>url to request</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>optional. dictionary of headers to add to request</td></tr><tr><td><code>body</code></td><td><code>string</code></td><td>optional. raw string body to provide to the request</td></tr><tr><td><code>form_body</code></td><td><code>dict</code></td><td>optional. dict of values that will be encoded as form data</td></tr><tr><td><code>form_encoding</code></td><td><code>string</code></td><td>optional. <code>application/x-www-form-url-encoded</code> (default) or <code>multipart/form-data</code></td></tr><tr><td><code>json_body</code></td><td><code>any</code></td><td>optional. json data to supply as a request. handy for working with JSON-API’s</td></tr><tr><td><code>auth</code></td><td><code>tuple</code></td><td>optional. (username,password) tuple for http basic authorization</td></tr></tbody></table><h3 id=def-bpostb>def <b>post</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>post</span><span class=p>(</span><span class=nx>url</span><span class=p>,</span><span class=nx>params</span><span class=p>={},</span><span class=nx>headers</span><span class=p>={},</span><span class=nx>body</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>form_body</span><span class=p>={},</span><span class=nx>form_encoding</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>json_body</span><span class=p>={},</span><span class=nx>auth</span><span class=p>=())</span> <span class=nx>response</span>
|
|
</code></pre></div><p>perform an HTTP POST request, returning a response</p><h6 id=arguments-4>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>url to request</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>optional. dictionary of headers to add to request</td></tr><tr><td><code>body</code></td><td><code>string</code></td><td>optional. raw string body to provide to the request</td></tr><tr><td><code>form_body</code></td><td><code>dict</code></td><td>optional. dict of values that will be encoded as form data</td></tr><tr><td><code>form_encoding</code></td><td><code>string</code></td><td>optional. <code>application/x-www-form-url-encoded</code> (default) or <code>multipart/form-data</code></td></tr><tr><td><code>json_body</code></td><td><code>any</code></td><td>optional. json data to supply as a request. handy for working with JSON-API’s</td></tr><tr><td><code>auth</code></td><td><code>tuple</code></td><td>optional. (username,password) tuple for http basic authorization</td></tr></tbody></table><h3 id=def-bputb>def <b>put</b></h3><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nf>put</span><span class=p>(</span><span class=nx>url</span><span class=p>,</span><span class=nx>params</span><span class=p>={},</span><span class=nx>headers</span><span class=p>={},</span><span class=nx>body</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>form_body</span><span class=p>={},</span><span class=nx>form_encoding</span><span class=p>=</span><span class=s>""</span><span class=p>,</span><span class=nx>json_body</span><span class=p>={},</span><span class=nx>auth</span><span class=p>=())</span> <span class=nx>response</span>
|
|
</code></pre></div><p>perform an HTTP PUT request, returning a response</p><h6 id=arguments-5>Arguments</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>url to request</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>optional. dictionary of headers to add to request</td></tr><tr><td><code>body</code></td><td><code>string</code></td><td>optional. raw string body to provide to the request</td></tr><tr><td><code>form_body</code></td><td><code>dict</code></td><td>optional. dict of values that will be encoded as form data</td></tr><tr><td><code>form_encoding</code></td><td><code>string</code></td><td>optional. <code>application/x-www-form-url-encoded</code> (default) or <code>multipart/form-data</code></td></tr><tr><td><code>json_body</code></td><td><code>any</code></td><td>optional. json data to supply as a request. handy for working with JSON-API’s</td></tr><tr><td><code>auth</code></td><td><code>tuple</code></td><td>optional. (username,password) tuple for http basic authorization</td></tr></tbody></table><h2 id=types>Types</h2><h3 id=type-bresponseb>type <b>response</b></h3><p>the result of performing a http request</p><h6 id=properties>Properties</h6><table><thead><tr><th>name</th><th>type</th><th>description</th></tr></thead><tbody><tr><td><code>url</code></td><td><code>string</code></td><td>the url that was ultimately requested (may change after redirects)</td></tr><tr><td><code>status_code</code></td><td><code>int</code></td><td>response status code (for example: 200 == OK)</td></tr><tr><td><code>headers</code></td><td><code>dict</code></td><td>dictionary of response headers</td></tr><tr><td><code>encoding</code></td><td><code>string</code></td><td>transfer encoding. example: “octet-stream” or “application/json”</td></tr></tbody></table><h6 id=methods>Methods</h6><h4 id=def-iresponseibbodyb>def <i>response</i>.<b>body</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>response</span><span class=p>.</span><span class=nf>body</span><span class=p>()</span> <span class=kt>string</span>
|
|
</code></pre></div><p>output response body as a string</p><h4 id=def-iresponseibjsonb>def <i>response</i>.<b>json</b></h4><div class=highlight><pre class=chroma><code class=language-go data-lang=go><span class=nx>response</span><span class=p>.</span><span class=nf>json</span><span class=p>()</span>
|
|
</code></pre></div><p>attempt to parse resonse body as json, returning a JSON-decoded result</p></div></div></div></div></div></div><div class=sub-footer><div class=container><div class=row><div class=col-12><div class=sub-footer-inner><ul><li><a href=https://github.com/mcuadros/ascod>Documentation version v1.3.0</a></li><li>Template by <a href=https://www.zerostatic.io>Robert Austin</a></li></ul></div></div></div></div><script type=text/javascript src=/js/scripts.min.be6fe1294698d6acd837c5182149cd1a24daae9fa1903ce810c264539d254d62.js></script></body></html> |