AshJsonApi.Api (ash_json_api v0.29.1) View Source

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

Table of Contents


Global configuration for JSON:API


json_api do
  prefix "/json_api"
  serve_schema? true
  log_errors? true

  • :router - The router that you created for this Api. Use by test helpers to send requests

  • :prefix - The route prefix at which you are serving the JSON:API

  • :serve_schema? - Whether or not create a /schema route that serves the JSON schema of your API The default value is false.

  • :authorize? - Whether or not to perform authorization for this API The default value is true.

  • :log_errors? - Whether or not to log any errors produced The default value is true.