Comment personnaliser to_json réponse dans Rails 3

Je suis en utilisant respond_with et tout ce qui est accroché en haut à droite pour obtenir les données correctement. Je veux personnaliser le retour de l' json, xml et foobar formats en voie SÈCHE, mais je ne peux pas comprendre comment le faire en utilisant le peu de :only et :include. Ce sont de grands lorsque les données sont simples, mais avec complexe trouve, ils tombent à court de ce que je veux.

Permet de dire que j'ai un post qui has_many images

def show
  @post = Post.find params[:id]
  respond_with(@post)
end

Je veux inclure des images avec la réponse, de sorte que je pourrais faire ceci:

def show
  @post = Post.find params[:id]
  respond_with(@post, :include => :images)
end

mais je n'ai pas vraiment envie d'envoyer la totalité de l'image de l'objet le long, juste l'url. En plus de cela, je veux vraiment être en mesure de faire quelque chose comme ceci (pseudo-code):

def show
  @post = Post.find params[:id]
  respond_with(@post, :include => { :foo => @posts.each.really_cool_method } )
end

def index
  @post = Post.find params[:id]
  respond_with(@post, :include => { :foo => @post.really_cool_method } )
end

... mais le tout dans une voie SÈCHE. Dans les anciens rails de projets, j'ai utilisé XML constructeurs pour personnaliser la sortie, mais la réplique à travers json, xml, html, ce que ne semble pas droit. J'ai d'imaginer que les rails gourous de mettre quelque chose dans Rails 3, que je ne suis pas réaliser ce type de comportement. Des idées?

OriginalL'auteur coneybeare | 2010-09-15

  1. 21

    Vous pouvez remplacer as_json dans votre modèle.
    Quelque chose comme:

    class Post < ActiveRecord::Base
  def as_json(options = {})
    {
      attribute: self.attribute, # and so on for all you want to include
      images:    self.images,    # then do the same `as_json` method for Image
      foo:       self.really_cool_method
    }
  end
end

    Et les Rails prend en charge le reste lors de l'utilisation de respond_with. pas entièrement sûr de ce options obtient mis à, mais probablement les options que vous donnez à respond_with (:include, :only et ainsi de suite)

    Il veut changer as_json, as_xml, as_foobar tous dans un seul endroit.
    Ouais, ce n'est pas vraiment SEC
    include ne pas utiliser as_json, cela n'aide pas.

    OriginalL'auteur PerfectlyNormal

  2. 8

    Probablement trop tard, mais j'ai trouvé un plus SEC de la solution de creuser à travers les rails de docs. Cela fonctionne dans ma brève tests, mais peut-être besoin de quelques ajustements:

    # This method overrides the default by forcing an :only option to be limited to entries in our
# PUBLIC_FIELDS list
def serializable_hash(options = nil)
  options ||= {}
  options[:only] ||= []
  options[:only] += PUBLIC_FIELDS
  options[:only].uniq!
  super(options)
end

    Cela vous permet donc d'avoir une liste de champs qui sont autorisés pour votre API publique, et vous ne pouvez pas accidentellement exposer l'ensemble de l'objet. Vous pouvez toujours exposer des domaines spécifiques manuellement, mais par défaut, votre objet est sécurisé .to_json, .to_xml, etc.

    En fait, ce devrait probablement juste valeur par défaut lorsque :seulement n'est pas indiqué, sinon, ça change de l'intention de l'utiliser :seulement. Oh, bien, toujours de mon point est le même.
    Primordial serializable_hash ont mieux fonctionné pour moi d'ajouter dans certaines méthodes comme des attributs dans les Rails 3.2.8, merci!
    C'est la réponse correcte. Fonctionne également dans les Rails 4.

    OriginalL'auteur Nerdmaster

  3. 7

    Ce n'est pas les rails 3 chemin, mais j'ai trouvé un joyau qui est activement maintenu sur Rails 3: acts_as_api

    Ce lien est une page 404.
    github.com/fabrik42/acts_as_api

    OriginalL'auteur coneybeare