clj-http.lite.client — com.github.lread/muckabout 1.4.2

Batteries-included HTTP client.

Among the many functions here you'll likely be most interested in get head put post delete or the slightly lower level request.

accept-encoding-value clj

(accept-encoding-value accept-encoding)

basic-auth-value clj

(basic-auth-value basic-auth)

content-type-value clj

(content-type-value type)

delete clj

(delete url & [req])

Executes HTTP DELETE request for url and, optionally, more req attributes. See request.

follow-redirect clj

(follow-redirect client req resp)

generate-query-string clj

(generate-query-string params)

get clj

(get url & [req])

Executes HTTP GET request for url and, optionally, more req attributes. See request.

head clj

(head url & [req])

Executes HTTP HEAD request for url and, optionally, more req attributes. See request.

parse-url clj

(parse-url url)

parse-user-info clj

(parse-user-info user-info)

post clj

(post url & [req])

Executes HTTP POST request for url and, optionally, more req attributes. See request.

put clj

(put url & [req])

Executes HTTP PUT request for url and, optionally, more req attributes. See request.

request clj

(request req)

Returns response map for executed HTTP req map.

Notice that some req key entries will be overwritten by automatic conversion to other key entries:

Request method

• :method - ex. :get,:head,:post,:put,:delete, converts to :request-method with same value

Request URL

• :url - ex. "https://joe:[e-mail]:443/some/path?q=clojure", converts to:
  • :scheme - protocol :https
  • :server-name - host "example.com"
  • :server-port - 443 (if not specified, will be inferred from :scheme)
  • :uri - path "/some/path"
  • :user-info - "joe:blow", converts to:
    • :basic-auth - which automatically converts to appropriate :headers
  • :query-string - "q=clojure"
• :query-params - ex. {"q" "clojure"} or {:q "clojure"} converts to :query-string (see above)

Request body & headers

• :body - can be a string, byte array, File or input stream
• :body-encoding - charset ex. "UTF-16", defaults to "UTF-8", iff :body is string converts to:
  • :body encoded in charset
  • :character-encoding set to charset which converts to appropriate :headers iff :content-type also set
• :content-type - media type of request body, converts to appropriate :headers entry, specify:
  • keyword as shorthand, ex. :json for "application/json"
  • string for verboten, ex. "text/html"
• :form-params - ex. {"q" "clojure"} or {:q "clojure"}, iff :method is :post: converts to:
  • urlencoded :body
  • appropriate :headers entry
• :oauth-token - bearer authorization token, ex. "my70k3nh3r3", converts to appropriate :headers entry
• :basic-auth - basic authentication, converts to appropriate :headers entry, (see also :url and :user-info), specify:
  • vector ["uname" "pass"] becomes "uname:pass"
  • use string for verboten
• :accept-encoding - vector of accepted response encodings, ex. [:gzip :deflate :identity], converts to appropriate :headers entry
• :accept - accept response of media type, converts to appropriate :headers entry, specify
  • keyword as shorthand, ex. :json for "application/json"
  • string for verboten, ex. "text/html"
• :headers - explicitly set request headers, ex. {"Cache-Control" "no-cache"}

Request behaviour

• :as - specifies how response body should be coerced:
  • :stream
  • :byte-array
  • :auto - to string decoded with charset in response :headers content-type charset else UTF-8
  • "charset" - to string decoded with charset ex. "utf-16"
  • else - to string decoded with UTF-8
• :follow-redirects - specify false to not follow response redirects
• :throw-exceptions - specify false to not throw on https status error codes
• :ignore-unknown-host? - specify true to not throw on unknown host
• :insecure? - allow connection with an invalid SSL certificate
• :conn-timeout - number of milliseconds to wait to establish a connection
• :socket-timeout - number of milliseconds to wait for data to be available to read
• :save-request? - specify true to include ultimate converted :request used in response map
• :chunk-size - in bytes, enables streaming of HTTP request body with chunk-size bytes, see JDK docs for details

Response map keys:

• :status - http status code, see :throw-exceptions above
• :headers - response headers
• :body - response body, gzip and deflate responses are accepted and decompressed. See :as above.
• :request - see :save-request? above

See README for example usages.

unexceptional-status? clj

update clj

(update m k f & args)

when-pos clj

(when-pos v)

with-connection-pool clj macro

(with-connection-pool _opts & body)

This macro is a no-op, but left in to support backward-compatibility with clj-http.

wrap-accept clj

(wrap-accept client)

wrap-accept-encoding clj

(wrap-accept-encoding client)

wrap-basic-auth clj

(wrap-basic-auth client)

wrap-content-type clj

(wrap-content-type client)

wrap-decompression clj

(wrap-decompression client)

wrap-exceptions clj

(wrap-exceptions client)

wrap-form-params clj

(wrap-form-params client)

wrap-input-coercion clj

(wrap-input-coercion client)

wrap-method clj

(wrap-method client)

wrap-nested-params clj

(wrap-nested-params client)

wrap-oauth clj

(wrap-oauth client)

wrap-output-coercion clj

(wrap-output-coercion client)

wrap-query-params clj

(wrap-query-params client)

wrap-redirects clj

(wrap-redirects client)

wrap-request clj

(wrap-request request)

Returns a batteries-included HTTP request function.

wrap-unknown-host clj

(wrap-unknown-host client)

wrap-url clj

(wrap-url client)

wrap-user-info clj

(wrap-user-info client)