ditkrg/active_model_serializers
4
0
Fork 0
mirror of https://github.com/ditkrg/active_model_serializers.git synced 2026-01-25 07:16:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update readme to reflect yehuda's change from :as to :key

Browse Source
This commit is contained in:
Adman65 2011-12-09 15:43:40 +01:00
parent 09ddc79ce0
commit a0388a316f
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.textile
View File

@ -355,25 +355,25 @@ h4. Modifying Associations
You can also rename associations if required. Say for example you have an association that You can also rename associations if required. Say for example you have an association that
makes sense to be named one thing in your code, but another when data is serialized. makes sense to be named one thing in your code, but another when data is serialized.
You can use the <code>:as</code> option to specify a different name for an association. You can use the <code:key</code> option to specify a different name for an association.
Here is an exmaple: Here is an exmaple:
<pre lang="ruby"> <pre lang="ruby">
class UserSerializer < ActiveModel::Serializer class UserSerializer < ActiveModel::Serializer
has_many :followed_posts, :as => :posts has_many :followed_posts, :key => :posts
has_one :owne_account, :as => :account has_one :owned_account, :key => :account
end end
</pre> </pre>
Using the <code>:as</code> without a <code>:serializer</code> option will use implicit detection Using the <code>:key</code> without a <code>:serializer</code> option will use implicit detection
to determine a serializer. In this example, you'd have to define two classes: <code>PostSerializer</code> to determine a serializer. In this example, you'd have to define two classes: <code>PostSerializer</code>
and <code>AccountSerializer</code>. You can also add the <code>:serializer</code> option and <code>AccountSerializer</code>. You can also add the <code>:serializer</code> option
to set it explicitly: to set it explicitly:
<pre lang="ruby"> <pre lang="ruby">
class UserSerializer < ActiveModel::Serializer class UserSerializer < ActiveModel::Serializer
has_many :followed_posts, :as => :posts, :serializer => CustomPostSerializer has_many :followed_posts, :key => :posts, :serializer => CustomPostSerializer
has_one :owne_account, :as => :account, :serializer => PrivateAccountSerializer has_one :owne_account, :key => :account, :serializer => PrivateAccountSerializer
end end
</pre> </pre>