Packages

ash_json_api

0.33.1
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.

HexDocs

Current section

Files

Jump to
Readme
146 Versions
5 Dependencies
4 Dependants
Files
Activity
ash_json_api documentation dsls DSL:-AshJsonApi.Api.cheatmd
Raw

documentation/dsls/DSL:-AshJsonApi.Api.cheatmd 

# DSL: AshJsonApi.Api



The entrypoint for adding JSON:API behavior to an Ash API





## json_api

Global configuration for JSON:API









### Examples

```

json_api do

  prefix "/json_api"

  log_errors? true

end



```









### Options

| Name | Type | Default | Docs |

| ---  | ---  | ---     | ---  |

| `router` | `atom` |  | The router that you created for this Api. Use by test helpers to send requests |

| `prefix` | `String.t` |  | The route prefix at which you are serving the JSON:API |

| `serve_schema?` | `boolean` | `false` | Whether or not create a /schema route that serves the JSON schema of your API |

| `authorize?` | `boolean` | `true` | Whether or not to perform authorization for this API |

| `log_errors?` | `boolean` | `true` | Whether or not to log any errors produced |