MikrotikApi.Transport behaviour (mikrotik_api v0.3.4)

Behaviour for pluggable MikroTik API transports.

The default transport is MikrotikApi.Transport.Httpc. Tests can use MikrotikApi.Transport.Mock to stub RouterOS REST endpoints without a device.

Custom transports must implement request/5 and return the same shape as Erlang :httpc responses after normalization:

{:ok, {status, response_headers, response_body}}
{:error, reason}

Summary

body()

headers()

method()

resp_body()

resp_headers()

status()

url()

@type body() :: iodata() | :undefined

@type headers() :: [{charlist(), charlist()}]

@type method() :: :get | :post | :put | :patch | :delete

@type resp_body() :: binary()

@type resp_headers() :: [{charlist(), charlist()}]

@type status() :: pos_integer()

@type url() :: charlist()

@callback request(method(), url(), headers(), body(), keyword()) ::
  {:ok, {status(), resp_headers(), resp_body()}} | {:error, term()}