ActiveModelSerializers brings convention over configuration to your JSON generation.
ActiveModelSerializers works through two components: serializers and adapters.
Serializers describe which attributes and relationships should be serialized.
Adapters describe how attributes and relationships should be serialized.
SerializableResource co-ordinates the resource, Adapter and Serializer to produce the resource serialization. The serialization has the #as_json, #to_json and #serializable_hash methods used by the Rails JSON Renderer. (SerializableResource actually delegates these methods to the adapter.)
By default ActiveModelSerializers will use the Attributes Adapter. But we strongly advise you to use JsonApi Adapter, which follows 1.0 of the format specified in jsonapi.org/format. Check how to change the adapter in the sections below.
ActiveModel::Serializers alternatives and similar gems
Based on the "API Builder" category.
Alternatively, view ActiveModel::Serializers alternatives based on common mentions on social networks and blogs.
9.7 6.1 L5 ActiveModel::Serializers VS GrapeAn opinionated framework for creating REST-like APIs in Ruby.
No Longer Maintained - A lightning fast JSON:API serializer for Ruby Objects.
8.9 6.0 L5 ActiveModel::Serializers VS jbuilderJbuilder: generate JSON objects with a Builder-style DSL
A resource-focused Rails library for developing JSON:API compliant servers.
7.4 2.6 L5 ActiveModel::Serializers VS RoarParse and render REST API documents using representers.
6.0 2.7 ActiveModel::Serializers VS JSONA fast JSON:API serializer for Ruby (fork of Netflix/fast_jsonapi)
Simple, Fast, and Declarative Serialization Library for Ruby
5.4 6.1 L5 ActiveModel::Serializers VS PlinyAn opinionated toolkit for writing excellent APIs in Ruby.
3.9 0.0 L5 ActiveModel::Serializers VS PraxisPraxis is a framework that focuses on both the design and implementation aspects of creating APIs.
Efficiently produce and consume JSON API documents.
API wrapper builder with response serialization
An expressive, opinionated ecosystem for building beautiful RESTful APIs with Ruby.
A tiny, HAL-compliant JSON presenter for your Ruby APIs.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of ActiveModel::Serializers or a related project?
ActiveModelSerializers is undergoing some renovations. See Development Status.
If you find a bug, please report an Issue and see our [contributing guide](CONTRIBUTING.md).
If you have a question, please post to Stack Overflow.
If you'd like to chat, we have a community slack.
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
- ❗️ 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](CHANGELOG-prehistory.md) 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.
- jsonapi-rb is a highly performant and modular JSON:API-only implementation. There's a vibrant community around it that has produced projects such as JSON:API Suite.
- fast_jsonapi is a lightning fast JSON:API serializer for Ruby Objects.
- jsonapi-resources is a popular resource-focused framework for implementing JSON:API servers.
- blueprinter is a fast, declarative, and API spec agnostic serializer that uses composable views to reduce duplication. From your friends at Procore.
For benchmarks against alternatives, see https://github.com/rails-api/active_model_serializers/tree/benchmarks
This project adheres to semver