HomeSetup Developer Handbook¶
Applications handbook
Table of contents¶
Fetch¶
usage: fetch.bash <method> <url> [options]
Fetch a URL using curl with optional headers, body, and formatting.
options:
-b | --body <json_body> : HTTP request body (payload).
-f | --format : Pretty-print JSON responses when possible.
-H | --headers <headers> : Comma-separated HTTP request headers.
-s | --silent : Omit informational messages.
-t | --timeout <seconds> : Request timeout (default: 3).
-h | --help : Display this help message.
-v | --version : Print version information.
Purpose¶
Fetch URL resource using the most commons ways.
Returns¶
0 if the command executed successfully; non-zero otherwise.
Parameters¶
- $1 Required : The Http method to be used.
- $2 Required : The URL to fetch.
Examples¶
fetch.bash GET example.com
Output
<!doctype html>
<html>
<head>
<title>Example Domain</title>
<meta charset="utf-8" />
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<style type="text/css">
body {
background-color: #f0f0f2;
margin: 0;
padding: 0;
font-family: -apple-system, system-ui, BlinkMacSystemFont, "Segoe UI", "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
}
div {
width: 600px;
margin: 5em auto;
padding: 2em;
background-color: #fdfdff;
border-radius: 0.5em;
box-shadow: 2px 3px 7px 2px rgba(0,0,0,0.02);
}
a:link, a:visited {
color: #38488f;
text-decoration: none;
}
@media (max-width: 700px) {
div {
margin: 0 auto;
width: auto;
}
}
</style>
</head>
<body>
<div>
<h1>Example Domain</h1>
<p>This domain is for use in illustrative examples in documents. You may use this
domain in literature without prior coordination or asking for permission.</p>
<p><a href="https://www.iana.org/domains/example">More information...</a></p>
</div>
</body>
</html>
fetch.bash POST --headers "context-type=application/json,accept=*/*" --body='{"id": 123}' localhost:8080/rest/api
Output
{
"id": 123,
"name": "test_job",
"status": "STARTED"
}