mirror of
https://github.com/ditkrg/active_model_serializers.git
synced 2026-01-23 06:16:50 +00:00
3d986377b6
Idea per remear (Ben Mills) in the slack: https://amserializers.slack.com/archives/general/p1455140474000171 remear: just so i understand, the adapter in `render json: resource, status: 422, adapter: 'json_api/error', serializer: ActiveModel::Serializer::ErrorSerializer` is a different one than, say what i’ve specified in a base serializer with `ActiveModel::Serializer.config.adapter = :json_api`. correct? and a followup question of, why not same adapter but different serializer? me: With the way the code is written now, it might be possible to not require a special jsonapi adapter. However, the behavior is pretty different from the jsonapi adapter. this first draft of the PR had it automatically set the adapter if there were errors. since that requires more discussion, I took a step back and made it explicit for this PR If I were to re-use the json api adapter and remove the error one, it think the serializable hash method would look like ``` def serializable_hash(options = nil) return { errors: JsonApi::Error.collection_errors } if serializer.is_a?(ErrorsSerializer) return { errors: JsonApi::Error.resource_errors(serializer) } if serializer.is_a?(ErrorSerializer) options ||= {} ``` I suppose it could be something more duckish like ``` def serializable_hash(options = nil) if serializer.errors? # object.errors.any? || object.any? {|o| o.errors.any? } JsonApi::Error.new(serializer).serializable_hash else # etc ```
57 lines
1.7 KiB
Markdown
57 lines
1.7 KiB
Markdown
[Back to Guides](../README.md)
|
|
|
|
# JSON API Errors
|
|
|
|
Rendering error documents requires specifying the error serializer(s):
|
|
|
|
- Serializer:
|
|
- For a single resource: `serializer: ActiveModel::Serializer::ErrorSerializer`.
|
|
- For a collection: `serializer: ActiveModel::Serializer::ErrorsSerializer`, `each_serializer: ActiveModel::Serializer::ErrorSerializer`.
|
|
|
|
The resource **MUST** have a non-empty associated `#errors` object.
|
|
The `errors` object must have a `#messages` method that returns a hash of error name to array of
|
|
descriptions.
|
|
|
|
## Use in controllers
|
|
|
|
```ruby
|
|
resource = Profile.new(name: 'Name 1',
|
|
description: 'Description 1',
|
|
comments: 'Comments 1')
|
|
resource.errors.add(:name, 'cannot be nil')
|
|
resource.errors.add(:name, 'must be longer')
|
|
resource.errors.add(:id, 'must be a uuid')
|
|
|
|
render json: resource, status: 422, adapter: :json_api, serializer: ActiveModel::Serializer::ErrorSerializer
|
|
# #=>
|
|
# { :errors =>
|
|
# [
|
|
# { :source => { :pointer => '/data/attributes/name' }, :detail => 'cannot be nil' },
|
|
# { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be longer' },
|
|
# { :source => { :pointer => '/data/attributes/id' }, :detail => 'must be a uuid' }
|
|
# ]
|
|
# }.to_json
|
|
```
|
|
|
|
## Direct error document generation
|
|
|
|
```ruby
|
|
options = nil
|
|
resource = ModelWithErrors.new
|
|
resource.errors.add(:name, 'must be awesome')
|
|
|
|
serializable_resource = ActiveModel::SerializableResource.new(
|
|
resource, {
|
|
serializer: ActiveModel::Serializer::ErrorSerializer,
|
|
adapter: :json_api
|
|
})
|
|
serializable_resource.as_json(options)
|
|
# #=>
|
|
# {
|
|
# :errors =>
|
|
# [
|
|
# { :source => { :pointer => '/data/attributes/name' }, :detail => 'must be awesome' }
|
|
# ]
|
|
# }
|
|
```
|