Packages
ash_json_api
1.4.29
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0-rc.2
1.6.0-rc.1
1.6.0-rc.0
1.5.1
1.5.0
1.4.45
1.4.44
1.4.43
1.4.42
1.4.41
1.4.40
1.4.39
1.4.38
1.4.37
1.4.36
1.4.35
1.4.34
1.4.33
1.4.32
1.4.31
1.4.30
1.4.29
1.4.28
1.4.27
1.4.26
1.4.25
1.4.24
1.4.23
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
retired
1.3.3
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.34.2
0.34.1
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.3
0.31.2
retired
0.31.1
0.31.0
0.30.1
0.30.0-rc.4
0.30.0-rc.3
0.30.0-rc.2
0.30.0-rc.1
0.30.0-rc.0
0.29.1
0.29.0
0.28.6
0.28.5
0.28.4
0.28.3
0.28.2
0.28.1
0.28.0
0.27.6
0.27.5
0.27.1
0.27.0
0.25.0
0.24.4
0.24.2
0.24.1
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.10.0
0.9.0
0.8.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.4
0.2.3
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
The JSON:API extension for the Ash Framework.
Current section
Files
Jump to
Current section
Files
lib/ash_json_api/router.ex
defmodule AshJsonApi.Router do
@moduledoc """
Use this module to create a router for your AshJsonApi.
To use this, create a module and do the following:
```elixir
defmodule YourRouter do
use AshJsonApi.Router,
domains: [YourDomain, YourOtherDomain],
# these next two are optional, only add them if you want those endpoints
open_api: "/open_api",
json_schema: "/json_schema",
# tell us where it is mounted in your router
prefix: "/api/json"
end
```
Then in your Phoenix router or plug pipeline, forward to this plug.
In phoenix, that looks like this:
```elixir
forward "/api", YourRouter
```
## Customizing request handling
You can provide the `before_dispatch` option to customize request handling.
This can also be used to do things like set monitoring/observability information,
like which domain/resource/route is handling the request.
For example:
```elixir
use AshJsonApi.Router,
...,
before_dispatch: {__MODULE__, :before_dispatch, []}
def before_dispatch(conn, route_info) do
...
end
```
`route_info` will be one of the following:
- `:open_api` - The open api is being requested
- `:json_schema` - The json schema is being requested
- `:not_found` - No matching route was found
- A map containing the keys: `domain`, `resource`, `route`, `params`
"""
defmacro __using__(opts) do
opts = Macro.expand_literals(opts, __CALLER__)
quote bind_quoted: [opts: opts] do
require Ash.Domain.Info
use Plug.Router
require Ash
@opts opts
@domains List.wrap(@opts[:domain] || @opts[:domains])
@opts Keyword.put(@opts, :domains, @domains)
if Code.ensure_loaded?(Phoenix.Router) &&
function_exported?(Phoenix.Router, :__formatted_routes__, 1) do
@behaviour Phoenix.VerifiedRoutes
def formatted_routes(_opts) do
AshJsonApi.Router.formatted_routes(__MODULE__)
end
def verified_route?(_opts, path) do
AshJsonApi.Router.verified_route?(__MODULE__, path)
end
end
def domains do
@domains
end
plug(:match)
plug(Plug.Parsers,
parsers: [:json],
pass: ["application/vnd.api+json"],
json_decoder: Jason
)
plug(:dispatch)
match(_,
to: AshJsonApi.Controllers.Router,
init_opts: @opts
)
if Code.ensure_loaded?(AshJsonApi.OpenApi) do
def spec do
AshJsonApi.OpenApi.spec(@opts)
end
end
end
end
@doc false
def formatted_routes(router) do
router.domains()
|> Enum.flat_map(&AshJsonApi.Domain.Info.routes/1)
|> Enum.map(fn route ->
%{
verb: route.method,
path: route.route,
label: "#{inspect(router)} #{inspect(route.resource)}.#{route.action}"
}
end)
end
@doc false
def verified_route?(router, path) do
router
|> formatted_routes()
|> Enum.map(fn route ->
case Path.split(route.path) do
["/" | rest] -> rest
path -> path
end
end)
|> Enum.any?(&match_path?(&1, path))
end
defp match_path?([], []), do: true
defp match_path?([], _), do: false
defp match_path?(_, []), do: false
defp match_path?([":" <> _ | rest_route], [_ | rest_path]) do
match_path?(rest_route, rest_path)
end
defp match_path?(["_" <> _ | rest_route], [_ | rest_path]) do
match_path?(rest_route, rest_path)
end
defp match_path?(["*" <> _], _) do
true
end
defp match_path?([same | rest_path], [same | rest_route]) do
match_path?(rest_path, rest_route)
end
defp match_path?(_, _) do
false
end
end