chart-api.core — chart-api 1.0.0

*api-context* clj

Dynamic API context to be applied in API calls.

auth->opts clj

(auth->opts {:keys [type in param-name]} value)

Process the given auth to an option map that might conatin request options and parameters.

auth-definitions clj

auths->opts clj

(auths->opts auth-names)

Process the given auth names to an option map that might conatin request options and parameters.

call-api clj

(call-api path
          method
          {:keys [path-params body-param content-types accepts auth-names]
           :as opts})

Call an API by making HTTP request and return its response.

check-required-params clj macro

(check-required-params & params)

Throw exception if any of the given parameters is nil.

default-api-context clj

Default API context.

deserialize clj

(deserialize {:keys [body] {:keys [content-type]} :headers})

Deserialize the given HTTP response according to the Content-Type header.

form-params->multipart clj

(form-params->multipart form-params)

Convert the given form parameters map into a vector as clj-http's :multipart option.

format-date clj

(format-date date)

Format the given Date object with the :date-format defined in api-options. NOTE: The UTC time zone is used.

format-datetime clj

(format-datetime date)

(format-datetime date time-zone)

Format the given Date object with the :datetime-format defined in api-options. NOTE: The system's default time zone is used when not provided.

json-mime? clj

(json-mime? mime)

Check if the given MIME is a standard JSON MIME or :json.

json-preferred-mime clj

(json-preferred-mime mimes)

Choose a MIME from the given MIMEs with JSON preferred, i.e. return JSON if included, otherwise return the first one.

make-url clj

(make-url path path-params)

Make full URL by adding base URL and filling path parameters.

normalize-array-param clj

(normalize-array-param xs)

Normalize array paramater according to :collection-format specified in the parameter's meta data. When the parameter contains File, a seq is returned so as to keep File parameters. For :multi collection format, a seq is returned which will be handled properly by clj-http. For other cases, a string is returned.

normalize-param clj

(normalize-param param)

Normalize parameter value, handling three cases: for sequential value, apply normalize-array-param which handles collection format; for File value, use current value; otherwise, apply param->str.

normalize-params clj

(normalize-params params)

Normalize parameters values: remove nils, format to string with param->str.

param->str clj

(param->str param)

Format the given parameter value to string.

parse-date clj

(parse-date s)

Parse the given string to a Date object with the :date-format defined in api-options. NOTE: The UTC time zone is used.

parse-datetime clj

(parse-datetime s)

(parse-datetime s time-zone)

Parse the given string to a Date object with the :datetime-format defined in api-options. NOTE: The system's default time zone is used when not provided.

process-auth clj

(process-auth opts auth-name)

Process the given auth name into options, which is merged into the given opts.

serialize clj

(serialize data content-type)

Serialize the given data according to content-type. Only JSON is supported for now.

with-api-context clj macro

(with-api-context api-context & body)

A helper macro to wrap api-context with default values.

with-collection-format clj

(with-collection-format param collection-format)

Attach collection-format to meta data of the given parameter.