vainglory.core — com.github.csm/vainglory 0.1.2

REST clients built from Swagger API definitions.

client clj

(client spec)

(client spec options)

Create a new REST client from the supplied Swagger/OpenAPI spec.

spec argument is a Swagger/OpenAPI specification (e.g. from load-yaml or load-json).

Optional option map may contain the following keys:

• :conn-pool An aleph.http connection pool, e.g. via [[aleph.http/connection-pool]].
• :api-id An optional string to use as the identifier of this API; must be unique across all clients you create. Defaults to a GUID based on the swagger spec.

invoke clj

(invoke client arg-map)

Invoke a REST call, blocking for a response.

Client should be produced with client.

Argument map has the following keys:

• :op A keyword naming the operation to invoke. Required.
• :request A map containing the request to pass; required based on operation -- see ops for a way to discover what arguments are required.
• :scheme -- :https or :http; required if no schemes are specified in the swagger spec.
• :host -- hostname to connect to; required if no hostname is specified in the swagger spec.
• :port -- port to connect to; optional, based on scheme used.
• :headers -- map of header name to value. Optional.
• :decode-key-fn -- function to use to decode JSON keys; default leaves keys as is; can be true to keywordize keys, or any arbitrary 1-arg function.

Return value will either be a response map, possibly with a :body, on success, or an anomaly map on failure.

load-json clj

(load-json readable)

Load a Swagger specification from a JSON source.

Argument may be anything that can be coerced to a Reader.

load-yaml clj

(load-yaml readable)

Load a Swagger specification from a YAML source.

Argument may be anything that can be coerced to a Reader.

ops clj

(ops client)

Describe operations client supports.

Returns a map of operation ID keywords to operation spec maps. Each operation spec will contain keys:

• :request A description of the request object to pass in.
• :response A description of the response body the operation returns, if any.
• :required A sequence of keys that are required in the :request map.
• :summary The summary from the swagger spec.
• :description The description from the swagger spec.