View Source Tesla.Middleware.PathParams (tesla v1.11.2)
Use templated URLs with provided parameters in either Phoenix style (:id
)
or OpenAPI style ({id}
).
Useful when logging or reporting metrics per URL.
Parameter Values
Parameter values may be struct/0
or must implement the Enumerable
protocol and produce {key, value}
tuples when enumerated.
Parameter Name Restrictions
Phoenix style parameters may contain letters, numbers, or underscores, matching this regular expression:
:[a-zA-Z][_a-zA-Z0-9]*
OpenAPI style parameters may contain letters, numbers, underscores, or
hyphens (-
), matching this regular expression:
{[a-zA-Z][-_a-zA-Z0-9]*}
In either case, parameters that begin with underscores (_
), hyphens (-
),
or numbers (0-9
) are ignored and left as-is.
Examples
defmodule MyClient do
use Tesla
plug Tesla.Middleware.BaseUrl, "https://api.example.com"
plug Tesla.Middleware.Logger # or some monitoring middleware
plug Tesla.Middleware.PathParams
def user(id) do
params = [id: id]
get("/users/{id}", opts: [path_params: params])
end
def posts(id, post_id) do
params = [id: id, post_id: post_id]
get("/users/:id/posts/:post_id", opts: [path_params: params])
end
end