Rails 3 respond_to : format par défaut ?

Question

Je suis en train de convertir une application Rails 2 en Rails 3. J'ai actuellement un contrôleur configuré comme suit :

class Api::RegionsController < ApplicationController
  respond_to :xml, :json
end

avec et une action qui ressemble à ce qui suit :

def index
  @regions = Region.all

  respond_with @regions  
end

La mise en œuvre est assez simple, api/regions, api/regions.xml et api/regions.json répondent tous comme prévu. Le problème est que je veux que les api/regions répondent par défaut via XML. J'ai des consommateurs qui attendent une réponse XML et je ne voudrais pas qu'ils modifient toutes leurs URL pour inclure .xml, sauf en cas de nécessité absolue.

Dans Rails 2, vous pouvez accomplir cela en faisant ceci :

respond_to do |format|
  format.xml { render :xml => @region.to_xml }
  format.json { render :json => @region.to_json }
end

Mais dans Rails 3, je n'arrive pas à trouver un moyen de le transformer en réponse XML par défaut. Une idée ?

Answer 1

Si je comprends ce que vous essayez de faire, vous pouvez probablement résoudre le problème en définissant le format de ressource par défaut sur XML. Cela permettra à vos utilisateurs d'effectuer des requêtes en utilisant "api/regions" et d'obtenir une réponse en XML par défaut. Jetez un coup d'œil aux sections "Controller Namespaces and Routing" et "Defining Defaults" sur le site :

http://guides.rubyonrails.org/routing.html

Vous pourriez faire quelque chose comme ce qui suit dans routes.rb :

namespace "api" do
  resources :regions, :defaults => { :format => 'xml' }
end

Vous devriez alors être en mesure de faire fonctionner les méthodes suivantes pour vos contrôleurs :

class Api::RegionsController < ApplicationController
  respond_to :xml, :json

  def index 
    respond_with(@regions = Region.all)
  end
end

Answer 2

Je me suis battu contre cette question aujourd'hui, et je me suis contenté du before_filter solution que vous avez vous-même mentionnée dans votre commentaire :

before_filter :default_format_xml

# Set format to xml unless client requires a specific format
# Works on Rails 3.0.9
def default_format_xml
  request.format = "xml" unless params[:format]
end

Cette solution permet également de prendre en compte la négociation du contenu, ce qui était un facteur dans mon cas. Je voulais que les navigateurs Web obtiennent une vue HTML mais que les clients personnalisés (sans en-tête Accept) obtiennent JSON. Cette solution a résolu mon problème :

before_filter :default_format_json

def default_format_json
  if(request.headers["HTTP_ACCEPT"].nil? &&
     params[:format].nil?)
    request.format = "json"
  end
end

Answer 3

Ce n'est pas ce que vous cherchez mais c'est lié :

def index
  @regions = Region.all
  respond_to do |format|
    format.json { render :json => @regions }
    format.any(:xml, :html) { render :xml => @regions }
  end
end

"Répondre à permet également de spécifier un bloc commun pour différents formats en utilisant n'importe quel"

• http://apidock.com/rails/v3.0.0/ActionController/MimeResponds/respond_to

Answer 4

Eh bien, comme il a été noté que chaque format doit être explicitement rendu avec un appel de rendu spécifique, vous pouvez également éviter toute demande avec un format inconnu ou non pris en charge, pour mon exemple appelé par défaut comme suit :

rescue_from ActionController::UnknownFormat, with: ->{ render nothing: true }

Vous pouvez simuler l'appel de format inconnu avec la ligne du navigateur simple (exmp.firefox) (en mode développement) :

http://localhost/index.default

Il appellera :index d'un contrôleur Root avec un format appelé par défaut .

Answer 5

Une solution simple mais peu élégante consiste à remplacer le traitement du type de contenu html par un traitement du xml :

   respond_to :html, :xml, :json

   def index
      @regions = Region.all
      respond_with @regions do |format|
        format.html { render :xml => @regions }
      end
    end