2011-01-15 8 views
16

Mi chiedo se qualcuno potrebbe dirmi se will_paginate può supportare JSON out of the box o se questo deve essere hackerato?will_paginate il supporto JSON?

Vorrei aggiungere dati di pagina alle risposte JSON mentre will_paginate gestisce l'impaginazione.

risposta

38

qualcosa nelle linee di:

@posts = Post.paginate :page => params[:page] 

respond_to do |format| 
    format.json { 
    render :json => { 
     :current_page => @posts.current_page, 
     :per_page => @posts.per_page, 
     :total_entries => @posts.total_entries, 
     :entries => @posts 
    } 
    } 
end 

Una volta a capire quale formato si desidera, si può sempre definire un metodo to_json su un WillPaginate :: Collezione.

+0

sì, questo è quello che sto cercando di fare, ora so come funziona, probabilmente restituisce quello che mi serve rendendolo direttamente a JSON, tuttavia, sono stato in grado di cambiare il formato in questo modo è utile. –

+3

controlla i documenti dell'API GitHub [1] per un modo molto migliore di codificare l'impaginazione nella tua risposta (suggerimento: inseriscilo nelle intestazioni) [1]: http://developer.github.com/v3/#pagination – asymmetric

+2

Come hai trovato questi metodi? Non sono elencati nel wiki will_paginate. – Francisco

1

will_paginate restituisce appena i record in modo affettato. Quindi ottiene solo un array dal tuo database.

Quando si esegue il rendering come json, i binari passano sopra la matrice di oggetti e chiamano as_json su di essi.

Quindi sì, puoi will_paginare il rendering come json.

+0

Ma suppongo che dovrò modificarlo in modo che includa il numero totale di pagine nella risposta JSON insieme ai dati paginati. –

+1

è tutto nella risposta di Model.paginate, quindi dovrai solo cercarlo nella risposta JSON. –

+0

Ne esaminerò anche io. @mislav fornito e un esempio di ciò che stavo cercando, tuttavia, posso vedere che solo il rendering dello standard output come JSON dovrebbe contenere anche le informazioni di cui ho bisogno. –

1

vi consiglio di guardare questo Railscast: Pagination with AJAX

+1

Non sto usando RJS quindi i dati devono essere nella risposta JSON –

8

Aggiunta paginazione a un'API

Ho trovato una soluzione facile API JSON Risposta Paginazione con will_pagination.

inizio con la creazione di un metodo di classe in ApplicationController che creerà un after_filter che fisserà l'impaginazione meta-dati nelle intestazioni di risposta:

application_controller.rb

class ApplicationController < ActionController::Base 

    protected 
    def self.set_pagination_headers(name, options = {}) 
    after_filter(options) do |controller| 
     results = instance_variable_get("@#{name}") 
     headers["X-Pagination"] = { 
     total: results.total_entries, 
     total_pages: results.total_pages, 
     first_page: results.current_page == 1, 
     last_page: results.next_page.blank?, 
     previous_page: results.previous_page, 
     next_page: results.next_page, 
     out_of_bounds: results.out_of_bounds?, 
     offset: results.offset 
     }.to_json 
    end 
    end 

end 

Poi, nel il controller che vogliamo aggiungere intestazioni di impaginazione possiamo chiamarlo così:

.515.053.691,36321 milioni

widgets_controller.rb

class Api::V1::WidgetsController < Api::V1::BaseController 
    set_pagination_headers :widgets, only: [:index] 

    def index 
    @widgets = Widget.all.paginate(params).order("created_at desc") 
    respond_with @widgets 
    end 

end 

intestazioni di risposta che assomigliano a questo

> Cache-Control:max-age=0, private, must-revalidate 
> Connection:keep-alive Content-Type:application/json; charset=utf-8 
> Etag:"fe70f7bae4c6e5cdea7867aa7fc0c7b4" 
> X-Pagination:{"total":14,"total_pages":1,"first_page":true,"last_page":true,"previous_page":null,"next_page":null,"out_of_bounds":false,"offset":0} 
> Server:thin 1.3.1 codename Triple Espresso 
> Set-Cookie:_widgets_session=BAh7CEkiD3Nlc3Npb25faWQGOgZFRkkiJTAzYjVlNzkwZTIyNzU4YTYwMDU0M2MwOTQ2ZWI3YWU2BjsAVEkiDWxhc3RfdXJsBjsARkkiM2h0dHA6Ly9tYWluYW5kbWUtc3RhZ2luZy5oZXJva3VhcHAuY29tL3VzZXJzLzEGOwBGSSIQX2NzcmZfdG9rZW4GOwBGSSIxdjd0SEp6cVhKamh5YTh1cnBUdmpBb0w5aVA0bS9QTEdON3g1UlFUYnBkND0GOwBG--71b3a24c216a414d8db04f312b5300c818e6bba4; 
> path=/; HttpOnly Transfer-Encoding:Identity 
> X-Request-Id:61b383ade49cba8b24a715a453ed6e1f X-Runtime:0.191485 
> X-Ua-Compatible:IE=Edge,chrome=1 

Source -Adding Pagination to an API

+0

Questa è una grande impaginazione per un'API. Non modificare i dati restituiti, inserire le informazioni di paginazione nelle intestazioni. Soluzione super pulita, funziona bene con altri come Angular che vuole una serie di risultati per un indice/elenco/query. – Ryan

2

La soluzione più semplice

def index 
    @posts = Post.all.paginate(:page => params[:page], :per_page => 4) 
    render :json => @posts.to_json(:methods => [:image_url]) 
    end 

si solo bisogno di aggiungere gem, will_pagination

funziona per me

0

Questo mi aiuta:

https://github.com/rails-api/active_model_serializers/blob/master/docs/howto/add_pagination_links.md

Adattato:

Aggiungi questo metodo per il controller di base API.

def pagination_dict(collection) 
    { 
    current_page: collection.current_page, 
    next_page: collection.next_page, 
    prev_page: collection.prev_page, # use collection.previous_page when using will_paginate 
    total_pages: collection.total_pages, 
    total_count: collection.total_count # use collection.total_entries when using will_paginate 
    } 
end 

Quindi, utilizzarlo sul metodo di rendering.

render json: posts, meta: pagination_dict(posts)