独自型を ExParamsSchema のフィールドとして利用するための仕様です。

adapter は外部入力をドメイン値またはプリミティブ値へ変換し、その値を JSON Schema 検証用の JSON 互換の値へ変換します。標準制約の検証は adapter ではなく ex_json_schema が担当します。

typespec/0 を実装すると、生成される params 構造体のフィールド型を AST で指定できます。 実装しない場合は、struct adapter の t/0 を参照し、それ以外は dynamic() として扱われます。

最小の adapter は必須 callback 3 つを実装します。

defmodule MyApp.TrimmedString do
  @behaviour ExParamsSchema.Type

  @impl true
  def cast(value, _options) when is_binary(value), do: {:ok, String.trim(value)}
  def cast(_value, _options), do: {:error, :not_a_string}

  @impl true
  def to_json(value, _options), do: value

  @impl true
  def json_schema(_options), do: %{"type" => "string"}

  @impl true
  def typespec, do: quote(do: String.t())
end

フィールドでは {Module, adapter_options} を型として指定します。フィールド option は外側の tuple に指定します。

field :slug, {MyApp.TrimmedString, []}, min_length: 1, error: :invalid_slug