https://github.com/rails-api/active_model_serializers

ActiveModel::Serializer implementation and Rails hooks
https://github.com/rails-api/active_model_serializers

Keywords

json resource-serializer ruby

Keywords from Contributors

activerecord activejob mvc rubygems rspec rack rubocop crash-reporting sinatra multithreading

Last synced: about 13 hours ago
JSON representation

Repository metadata

ActiveModel::Serializer implementation and Rails hooks

Host: GitHub
URL: https://github.com/rails-api/active_model_serializers
Owner: rails-api
License: mit
Created: 2011-12-01T06:39:26.000Z (about 14 years ago)
Default Branch: master
Last Pushed: 2025-11-11T16:18:28.000Z (about 1 month ago)
Last Synced: 2025-12-08T10:29:40.532Z (9 days ago)
Topics: json, resource-serializer, ruby
Language: Ruby
Homepage:
Size: 4.29 MB
Stars: 5,346
Watchers: 73
Forks: 1,386
Open Issues: 188
Releases: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-0-08.md
- Contributing: CONTRIBUTING.md
- License: MIT-LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

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.

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

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.
Alba is fast and spec agnostic serialization solution. It has some unique features such as global or per-resource error handling.
Transmutation is fast and lightweight JSON attribute serialization solution. It provides an intuitive serializer lookup, inspired from AMS.

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

Owner metadata

Name: rails-api
Login: rails-api
Email:
Kind: organization
Description:
Website:
Location:
Twitter:
Company:
Icon url: https://avatars.githubusercontent.com/u/2820360?v=4
Repositories: 6
Last ynced at: 2024-03-25T21:10:33.730Z
Profile URL: https://github.com/rails-api

GitHub Events

Total

Issues event: 10
Watch event: 49
Issue comment event: 25
Push event: 3
Pull request review comment event: 4
Pull request review event: 4
Pull request event: 10
Fork event: 8
Create event: 2

Last Year

Issues event: 5
Watch event: 37
Issue comment event: 9
Push event: 1
Pull request event: 7
Fork event: 2
Create event: 1

Committers metadata

Last synced: 2 days ago

Total Commits: 994
Total Committers: 201
Avg Commits per committer: 4.945
Development Distribution Score (DDS): 0.648

Commits in past year: 0
Committers in past year: 0
Avg Commits per committer in past year: 0.0
Development Distribution Score (DDS) in past year: 0.0

Name	Email	Commits
Benjamin Fleischer	g**b@b**m	350
Lucas Hosseini	l**i@g**m	81
João Moura	j**a@g**m	37
Tema Bolshakov	a**v@s**m	26
L. Preston Sego III	L**v@g**m	25
Steve Klabnik	s**e@s**m	23
Bruno Bacarini	b**o@g**m	22
Yohan Robert	y**t@o**r	21
Ben Mills	b**n@u**m	21
Mateo Murphy	m**y@g**m	19
Mauro George	m**t@g**m	14
Alexandre de Oliveira	c**o@g**m	13
Guillermo Iguaran	g**n@g**m	12
Alexey Dubovskoy	d**a@g**m	11
João M. D. Moura	j**o@r**m	9
Gary Gordon	g**n@g**m	8
Taylor Jones	t**e@g**m	7
Ryunosuke SATO	t**s@g**m	6
Josh Smith	j**h@c**m	6
Ben Woosley	b**y@g**m	5
CorainChicago	c**n@g**m	5
Eric Guo	e**o@s**m	5
Santiago Pastorino	s**o@w**m	5
bobba surendranath chowdary	b**a@g**m	5
Nicholas Shook	n**k@q**m	5
Aaron Renoir	a**n@f**m	4
Dave Gynn	d**n@g**m	4
Igor Zubkov	i**v@g**m	4
MSathieu	M****u	4
Rodrigo Ra	r**p@g**m	4
and 171 more...

Committer domains:

Issue and Pull Request metadata

Last synced: 6 days ago

Total issues: 83
Total pull requests: 101
Average time to close issues: 10 months
Average time to close pull requests: 8 months
Total issue authors: 81
Total pull request authors: 52
Average comments per issue: 5.27
Average comments per pull request: 2.54
Merged pull request: 46
Bot issues: 0
Bot pull requests: 0

Past year issues: 6
Past year pull requests: 7
Past year average time to close issues: about 3 hours
Past year average time to close pull requests: 3 days
Past year issue authors: 6
Past year pull request authors: 5
Past year average comments per issue: 2.17
Past year average comments per pull request: 1.43
Past year merged pull request: 3
Past year bot issues: 0
Past year bot pull requests: 0

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/rails-api/active_model_serializers

Top Issue Authors

NullVoxPopuli (2)
exocode (2)
chrismanderson (1)
pavan-itd (1)
alecvn (1)
giorgenes (1)
tygryszcz (1)
zedtux (1)
samsonjs (1)
devonparsons (1)
scottohara-frollo (1)
hadiS (1)
leoncruz (1)
Roguelazer (1)
Mhmonicox (1)

Top Pull Request Authors

casperisfine (16)
bf4 (8)
saiqulhaq (8)
wasifhossain (4)
tashirosota (3)
schinery (3)
timrosenblatt (2)
himynameisjonas (2)
eugeneius (2)
Mubramaj (2)
stefansundin (2)
vineelvineel (2)
Roguelazer (2)
Nitemaeric (2)
RyanNielson (2)

Top Issue Labels

V: 0.10.x (9)
S: Ready for PR (3)
S: Needs Bug Verification (3)
S: Needs Submitter Response (3)
S: Bug (2)
C: JSON API (2)
C: Feature (2)
S: Needs Team Discussion (2)
C: Performance (2)
C: Documentation (2)
C: Performance: Caching (2)
C: Question (2)
V: 0.8.x (1)
C: Legacy Adapter (1)
C: Upgrading (1)
C: Keys and Transform (1)

Top Pull Request Labels

V: 0.10.x (3)
C: Feature (2)
S: Needs Team Discussion (1)