DocRaptor.Client (DocRaptor v0.1.2)

Copy Markdown View Source

Configured DocRaptor HTTP client (Req-backed).

Create with new/1, then pass into DocRaptor helpers, or attach to a custom %Req.Request{} with attach/2.

Options for new/1

KeyRequiredDefaultNotes
:api_keyyes—DocRaptor API key
:testnotrueMerged into docs unless overridden per request
:base_urlno"https://api.docraptor.com"Override for stubs/proxies
:req_optionsno[]Extra Req options (e.g. plug:)

Prefer document_content (with inlined CSS/assets) over document_url when developing against localhost — DocRaptor cannot fetch private hosts without a tunnel.

Summary

Types

t()

Functions

attach(request, client)

Attaches DocRaptor auth and defaults to a %Req.Request{}.

new(opts)

Builds a client. :api_key is required. :test defaults to true.

Types

t()

@type t() :: %DocRaptor.Client{
  api_key: String.t(),
  base_url: String.t(),
  req_options: keyword(),
  test: boolean()
}

Functions

attach(request, client)

@spec attach(Req.Request.t(), t()) :: Req.Request.t()

Attaches DocRaptor auth and defaults to a %Req.Request{}.

Merges base_url, basic auth (api_key as username), receive_timeout: 60_000, decode_body: false, retry: false, plus any client.req_options.

High-level APIs call this; advanced callers can build custom Req pipelines:

body = %{
  "name" => "hello.pdf",
  "document_type" => "pdf",
  "document_content" => "<html/>",
  "test" => true
}

Req.new(method: :post, url: "/docs", json: body, decode_body: false)
|> DocRaptor.Client.attach(client)
|> Req.request()

new(opts)

@spec new(keyword() | map()) :: {:ok, t()} | {:error, DocRaptor.Error.t()}

Builds a client. :api_key is required. :test defaults to true.

Pass Req options (for example plug: {Req.Test, MyStub}) via :req_options.

Examples

{:ok, client} = DocRaptor.Client.new(api_key: "YOUR_API_KEY")
{:ok, client} = DocRaptor.Client.new(api_key: key, test: false)
{:error, %DocRaptor.Error{reason: :missing_api_key}} = DocRaptor.Client.new([])