View Source ExOAPI.Client (ex_oapi v0.1.3)

@type t() :: %ExOAPI.Client{
  adapter: {any(), Keyword.t()},
  base_url: nil | String.t(),
  body: any(),
  errors: [any()],
  headers: [{String.t(), String.t()}],
  method: nil | ExOAPI.EctoTypes.HTTPMethods.t(),
  middleware: middleware(),
  module: module() | nil,
  oapi_op: ExOAPI.Parser.V3.Context.Operation.t(),
  opts: Keyword.t(),
  outgoing_format: String.t(),
  path: nil | String.t(),
  query: Keyword.t(),
  replacements: [{String.t(), String.t()}],
  response_handler: function() | mfa(),
  strict_responses: boolean()
}

Link to this section Functions

add_arg_opts(client, type, in_type, opts, args)

add_arg_to_client(client, type, name, prepared_value)

add_base_url(client, url)

@spec add_base_url(t(), String.t()) :: t()

Sets the :base_url to be used as the API endpoint.

add_base_url(client, url, arg3)

@spec add_base_url(t(), String.t(), nil | :exoapi_default) :: t()

add_header(client, header, value)

@spec add_header(t(), String.t(), String.t() | nil) :: t()

Adds an header to the client.

add_middleware(client, middleware)

@spec add_middleware(t(), [middleware()] | middleware() | module()) :: t()

Adds middleware to the client that will be passed on to the Tesla request.

add_options(client, opts)

@spec add_options(t(), Keyword.t() | {atom(), any()}) :: t()

Adds options to be passed to the tesla adapter.

add_query(client, param, value)

@spec add_query(t(), String.t() | atom(), String.t() | nil) :: t()

Adds a query param to the client.

check_url_in_servers(base_url, servers)

maybe_create_url_from_servers(client)

replace_path_fragments(replacements, url)

request(client)

response_handler(response, client)

response_handler(response, client, fun)

set_adapter(client, adapter)

@spec set_adapter(
  t(),
  {any(), Keyword.t()}
) :: t()

Sets the adapter options that will be passed on to the Tesla request.

Settings View Source ExOAPI.Client (ex_oapi v0.1.3)

Link to this section Summary

Types

Functions

Link to this section Types

middleware()

t()