ActiveModelSerializers

About

ActiveModelSerializers is undergoing some renovations. See Development Status.

Getting Help

If you find a bug, please report an Issue and see our contributing guide.

If you have a question, please post to Stack Overflow.

If you'd like to chat, we have a community slack.

Thanks!

Documentation

If you're reading this at https://github.com/rails-api/active_model_serializers you are reading documentation for our master, which is not yet released.

0.10 (0-10-stable) Documentation Guides
0.9 (0-9-stable) Documentation
0.8 (0-8-stable) Documentation

Status of AMS

Status:

  • ❗️ All existing PRs against master will need to be closed and re-opened against 0-10-stable, if so desired
  • ❗️ Master, for the moment, won't have any released version of AMS on it.
  • :eyes: See below for alternatives

Changes to 0.10.x maintenance:

  • The 0.10.x version has become a huge maintenance version. We had hoped to get it in shape for a 1.0 release, but it is clear that isn't going to happen. Almost none of the maintainers from 0.8, 0.9, or earlier 0.10 are still working on AMS. We'll continue to maintain 0.10.x on the 0-10-stable branch, but maintainers won't otherwise be actively developing on it.
    • We may choose to make a 0.11.x ( 0-11-stable) release based on 0-10-stable that just removes the deprecations.

What's happening to AMS:

  • There's been a lot of churn around AMS since it began back in Rails 3.2 and a lot of new libraries are around and the JSON:API spec has reached 1.0.
  • If there is to be a 1.0 release of AMS, it will need to address the general needs of serialization in much the way ActiveJob can be used with different workers.
  • The next major release is in development. We're starting simple and avoiding, at least at the outset, all the complications in AMS version, especially all the implicit behavior from guessing the serializer, to the association's serializer, to the serialization type, etc.
  • The basic idea is that models to serializers are a one to many relationship. Everything will need to be explicit. If you want to serialize a User with a UserSerializer, you'll need to call it directly. The serializer will essentially be for defining a basic JSON:API resource object: id, type, attributes, and relationships. The serializer will have an as_json method and can be told which fields (attributes/relationships) to serialize to JSON and will likely not know serialize any more than the relations id and type. Serializing anything more about the relations would require code that called a serializer. (This is still somewhat in discussion).
  • If this works out, the idea is to get something into Rails that existing libraries can use.

See PR 2121 where these changes were introduced for more information and any discussion.

Alternatives

For benchmarks against alternatives, see https://github.com/rails-api/active_model_serializers/tree/benchmarks

Semantic Versioning

This project adheres to semver

Contributing

See CONTRIBUTING.md