TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-08 19:04:45 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document the responseHeaders option for resources.GetRemote

Browse Source
This commit is contained in:
Joe Mooring 2025-01-23 09:40:12 -08:00 committed by Bjørn Erik Pedersen
parent da7c12aaa5
commit e95d06592e
2 changed files with 81 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

95
content/en/functions/resources/GetRemote.md
View File

@ -44,6 +44,39 @@ Use the [`try`] statement instead, as shown in the [error handling] example belo
The `resources.GetRemote` function takes an optional map of options.
###### body
(`string`) The data you want to transmit to the server.
###### headers
(`map[string][]string`) The collection of key-value pairs that provide additional information about the request.
###### key
(`string`) The cache key. Hugo derives the default value from the URL and options map. See [caching](#caching).
###### method
(`string`) The action to perform on the requested resource, typically one of `GET`, `POST`, or `HEAD`.
###### responseHeaders
{{< new-in 0.143.0 >}}
(`[]string`) The headers to extract from the server's response, accessible through the resource's [`Data.Headers`] method. Header name matching is case-insensitive.
[`Data.Headers`]: /methods/resource/data/#headers
## Options examples
{{% note %}}
For brevity, the examples below do not include [error handling].
[error handling]: #error-handling
{{% /note %}}
To include a header:
```go-html-template
{{ $url := "https://example.org/api" }}
{{ $opts := dict
@ -52,7 +85,7 @@ The `resources.GetRemote` function takes an optional map of options.
{{ $resource := resources.GetRemote $url $opts }}
```
If you need multiple values for the same header key, use a slice:
To specify more than one value for the same header key, use a slice:
```go-html-template
{{ $url := "https://example.org/api" }}
@ -62,7 +95,7 @@ If you need multiple values for the same header key, use a slice:
{{ $resource := resources.GetRemote $url $opts }}
```
You can also change the request method and set the request body:
To post data:
```go-html-template
{{ $url := "https://example.org/api" }}
@ -74,6 +107,27 @@ You can also change the request method and set the request body:
{{ $resource := resources.GetRemote $url $opts }}
```
To override the default cache key:
```go-html-template
{{ $url := "https://example.org/images/a.jpg" }}
{{ $opts := dict
"key" (print $url (now.Format "2006-01-02"))
}}
{{ $resource := resources.GetRemote $url $opts }}
```
To extract specific headers from the server's response:
```go-html-template
{{ $url := "https://example.org/images/a.jpg" }}
{{ $opts := dict
"method" "HEAD"
"responseHeaders" (slice "X-Frame-Options" "Server")
}}
{{ $resource := resources.GetRemote $url $opts }}
```
## Remote data
When retrieving remote data, use the [`transform.Unmarshal`] function to [unmarshal](g) the response.
@ -148,40 +202,6 @@ The [`Data`] method on a resource returned by the `resources.GetRemote` function
[`Data`]: /methods/resource/data/
```go-html-template
{{ $url := "https://example.org/images/a.jpg" }}
{{ with try (resources.GetRemote $url) }}
{{ with .Err }}
{{ errorf "%s" . }}
{{ else with .Value }}
{{ with .Data }}
{{ .ContentLength }} → 42764
{{ .ContentType }} → image/jpeg
{{ .Status }} → 200 OK
{{ .StatusCode }} → 200
{{ .TransferEncoding }} → []
{{ end }}
{{ else }}
{{ errorf "Unable to get remote resource %q" $url }}
{{ end }}
{{ end }}
```
ContentLength
: (`int`) The content length in bytes.
ContentType
: (`string`) The content type.
Status
: (`string`) The HTTP status text.
StatusCode
: (`int`) The HTTP status code.
TransferEncoding
: (`string`) The transfer encoding.
## Caching
Resources returned from `resources.GetRemote` are cached to disk. See [configure file caches] for details.
@ -193,7 +213,8 @@ Override the cache key by setting a `key` in the options map. Use this approach
```go-html-template
{{ $url := "https://example.org/images/a.jpg" }}
{{ $cacheKey := print $url (now.Format "2006-01-02") }}
{{ $resource := resources.GetRemote $url (dict "key" $cacheKey) }}
{{ $opts := dict "key" $cacheKey }}
{{ $resource := resources.GetRemote $url $opts }}
```
[configure file caches]: /getting-started/configuration/#configure-file-caches

33
content/en/methods/resource/Data.md
View File

@ -17,6 +17,7 @@ The `Data` method on a resource returned by the [`resources.GetRemote`] function
```go-html-template
{{ $url := "https://example.org/images/a.jpg" }}
{{ $opts := dict "responseHeaders" (slice "Server") }}
{{ with try (resources.GetRemote $url) }}
{{ with .Err }}
{{ errorf "%s" . }}
@ -24,6 +25,7 @@ The `Data` method on a resource returned by the [`resources.GetRemote`] function
{{ with .Data }}
{{ .ContentLength }} → 42764
{{ .ContentType }} → image/jpeg
{{ .Headers }} → map[Server:[Netlify]]
{{ .Status }} → 200 OK
{{ .StatusCode }} → 200
{{ .TransferEncoding }} → []
@ -34,19 +36,30 @@ The `Data` method on a resource returned by the [`resources.GetRemote`] function
{{ end }}
```
ContentLength
: (`int`) The content length in bytes.
###### ContentLength
ContentType
: (`string`) The content type.
(`int`) The content length in bytes.
Status
: (`string`) The HTTP status text.
###### ContentType
StatusCode
: (`int`) The HTTP status code.
(`string`) The content type.
TransferEncoding
: (`string`) The transfer encoding.
###### Headers
(`map[string][]string`) A map of response headers matching those requested in the [`responseHeaders`] option passed to the `resources.GetRemote` function. The header name matching is case-insensitive. In most cases there will be one value per header key.
[`responseHeaders`]: /functions/resources/getremote/#responseheaders
###### Status
(`string`) The HTTP status text.
###### StatusCode
(`int`) The HTTP status code.
###### TransferEncoding
(`string`) The transfer encoding.
[`resources.GetRemote`]: /functions/resources/getremote/