A tiny curl wrapper via idiomatic Clojure, inspired by clj-http, Ring and friends.
NOTE: This library is mostly replaced by babashka.http-client which is mostly API-compatible with babashka.curl. The
babashka.http-clientlibrary is built-in as of babashka version 1.1.171.
This library is part of babashka
but can also be used with JVM Clojure. Check CHANGES.md before
upgrading as the API may still undergo some changes. Contributions welcome.
(require '[babashka.curl :as curl])
(require '[clojure.java.io :as io]) ;; optional
(require '[cheshire.core :as json]) ;; optionalSimple GET request:
(curl/get "https://httpstat.us/200")
;;=> {:status 200, :body "200 OK", :headers { ... }}Passing headers:
(def resp (curl/get "https://httpstat.us/200" {:headers {"Accept" "application/json"}}))
(json/parse-string (:body resp)) ;;=> {"code" 200, "description" "OK"}Query parameters:
(->
(curl/get "https://postman-echo.com/get" {:query-params {"q" "clojure"}})
:body
(json/parse-string true)
:args)
;;=> {:q "clojure"}To send multiple params to the same key:
;; https://postman-echo.com/get?q=clojure&q=curl
(curl/get "https://postman-echo.com/get" {:query-params [[:q "clojure"] [:q "curl"]]})A POST request with a :body:
(def resp (curl/post "https://postman-echo.com/post" {:body "From Clojure"}))
(json/parse-string (:body resp)) ;;=> {"args" {}, "data" "", ...}Posting a file as a POST body:
(:status (curl/post "https://postman-echo.com/post" {:body (io/file "README.md")}))
;; => 200Posting a stream as a POST body:
(:status (curl/post "https://postman-echo.com/post" {:body (io/input-stream "README.md")}))
;; => 200Posting form params:
(:status (curl/post "https://postman-echo.com/post" {:form-params {"name" "Michiel"}}))
;; => 200Basic auth:
(:body (curl/get "https://postman-echo.com/basic-auth" {:basic-auth ["postman" "password"]}))
;; => "{\"authenticated\":true}"Download a binary file:
(io/copy
(:body (curl/get "https://github.com/babashka/babashka/raw/master/logo/icon.png"
{:as :bytes}))
(io/file "icon.png"))
(.length (io/file "icon.png"))
;;=> 7748With :as :stream
(:body (curl/get "https://github.com/babashka/babashka/raw/master/logo/icon.png"
{:as :stream}))will return the raw input stream.
Passing raw arguments to curl can be done with :raw-args:
(:status (curl/get "http://www.clojure.org" {:raw-args ["--max-redirs" "0"] :throw false}))
;;=> 301Talking to a UNIX socket:
(-> (curl/get "http://localhost/images/json"
{:raw-args ["--unix-socket"
"/var/run/docker.sock"]})
:body
(json/parse-string true)
first
:RepoTags)
;;=> ["babashka/babashka:0.0.79-SNAPSHOT"]Using the low-level API for fine grained(and safer) URL construction:
(-> (curl/request {:url {:scheme "https"
:host "httpbin.org"
:port 443
:path "/get"
:query "q=test"}})
:body
(json/parse-string true))
;;=>
{:args {:q "test"},
:headers
{:Accept "*/*",
:Host "httpbin.org",
:User-Agent "curl/7.64.1",
:X-Amzn-Trace-Id
"Root=1-5e63989e-7bd5b1dba75e951a84d61b6a"},
:origin "46.114.35.45",
:url "https://httpbin.org/get?q=test"}Redirects are automatically followed. To opt out of this behaviour, set :follow-redirects to false.
(curl/get "https://httpstat.us/302" {:follow-redirects false})An ExceptionInfo will be thrown for all HTTP response status codes other than #{200 201 202 203 204 205 206 207 300 301 302 303 304 307}
or if curl exited with a non-zero exit code. The response map is the exception data.
(curl/get "https://httpstat.us/404")
;;=> Execution error (ExceptionInfo) at babashka.curl/request (curl.clj:228).
status 404
(:status (ex-data *e))
;;=> 404To opt out of an exception being thrown, set :throw to false.
(:status (curl/get "https://httpstat.us/404" {:throw false}))
;;=> 404If the body is being returned as a stream then exceptions are never thrown and the :exit value is wrapped in a Delay.
(:exit (curl/get "https://httpstat.us/404" {:as :stream}))
;;=> #object[clojure.lang.Delay 0x75769ab0 {:status :pending, :val nil}]
(force *1)
;;=> 0Error output can be found under the :err key:
(:err (curl/get "httpx://postman-echo.com/get" {:throw false}))
;;=> "curl: (1) Protocol \"httpx\" not supported or disabled in libcurl\n"From babashka 0.2.4 onwards, this library will call curl with --compressed
by default. To opt out, pass :compressed false in the options. On Windows 10
the default installed curl does not support this option. You can either upgrade
curl or perform all requests using :compressed false.
Set :debug to true to get debugging information along with the response. The
:command value contains the command that was executed to obtain the
response. The :options value contains options that were used to construct the
command. Note that all of these values are for debugging only and contain
implementation details that may change in the future.
(def resp (curl/head "https://postman-echo.com/head" {:debug true}))
(:command resp)
;;=> ["curl" "--silent" "--show-error" "--location" "--dump-header" "/var/folders/2m/h3cvrr1x4296p315vbk7m32c0000gp/T/babashka.curl16567082489957878064.headers" "--head" "https://postman-echo.com/head"]
(:options resp)
;;=> {:debug true, :url "https://postman-echo.com/head", :method :head, :header-file #object[java.io.File 0x61d34b4 "/var/folders/2m/h3cvrr1x4296p315vbk7m32c0000gp/T/babashka.curl16567082489957878064.headers"]}$ clojure -A:testCopyright © 2020 Michiel Borkent
Distributed under the EPL License, same as Clojure. See LICENSE.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent