open_api_spex v3.2.0 OpenApiSpex.Plug.Cast View Source
Module plug that will cast the Conn.params
and Conn.body_params
according to the schemas defined for the operation.
Note that when using this plug, the body params are no longer merged into Conn.params
and must be read from Conn.body_params
separately.
The operation_id can be given at compile time as an argument to init
:
plug OpenApiSpex.Plug.Cast, operation_id: "MyApp.ShowUser"
For phoenix applications, the operation_id can be obtained at runtime automatically.
defmodule MyAppWeb.UserController do
use Phoenix.Controller
plug OpenApiSpex.Plug.Cast
...
end
If you want customize the error response, you can provide the :render_error
option to register a plug which creates
a custom response in the case of a validation error.
Example
defmodule MyAppWeb.UserController do
use Phoenix.Controller
plug OpenApiSpex.Plug.Cast,
render_error: MyApp.RenderError
...
end
defmodule MyApp.RenderError do
def init(opts), do: opts
def call(conn, reason) do
msg = %{error: reason} |> Posion.encode!()
conn
|> Conn.put_resp_content_type("application/json")
|> Conn.send_resp(400, msg)
end
end