nimble install puppy
Puppy makes HTTP requests easy!
With Puppy you can make HTTP requests without needing to pass the -d:ssl flag or shipping extra *.dlls and cacerts.pem on Windows. Puppy avoids these gotchas by using system APIs instead of Nim's HTTP stack.
Some other highlights of Puppy are:
- Supports gzip'ed responses out of the box
- Make an HTTP request using a one-line
proccall
| OS | Method |
|---|---|
| Win32 | WinHttp WinHttpRequest |
| macOS | AppKit NSMutableURLRequest |
| Linux | libcurl easy_perform |
Curently does not support async
echo fetch("https://neverssl.com/")A call to fetch will raise PuppyError if the response status code is not 200.
Make a basic GET request:
import puppy
let response = get("https://www.google.com/")Need to pass headers?
import puppy
let response = get(
"https://neverssl.com/",
headers = @[("User-Agent", "Nim 1.0")]
)Easy one-line procs for your favorite verbs:
discard get(url, headers)
discard post(url, headers, body)
discard put(url, headers, body)
discard patch(url, headers, body)
discard delete(url, headers)
discard head(url, headers)Response* = ref object
headers*: HttpHeaders
code*: int
body*: stringimport puppy
let response = get("https://www.istrolid.com", @[("Auth", "1")])
echo response.code
echo response.headers
echo response.body.lenimport puppy
let body = "{\"json\":true}"
let response = post(
"https://api.website.com",
@[("Content-Type", "application/json")],
body
)
echo response.code
echo response.headers
echo response.body.lenUsing multipart/form-data:
var entries: seq[MultipartEntry]
entries.add MultipartEntry(
name: "input_text",
fileName: "input.txt",
contentType: "text/plain",
payload: "foobar"
)
entries.add MultipartEntry(
name: "options",
payload: "{\"utf8\":true}"
)
let (contentType, body) = encodeMultipart(entries)
var headers: HttpHeaders
headers["Content-Type"] = contentType
let response = post("Your API endpoint here", headers, body)See the examples/ folder for more examples.
You can pass -d:puppyLibcurl to force use of libcurl even on Windows and macOS. This is useful if for some reason the native OS API is not working.
Libcurl is typically ready-to-use on macOS and Linux. On Windows you'll need to grab the latest libcurl DLL from https://curl.se/windows/, rename it to libcurl.dll, and put it in the same directory as your executable.