JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Namespaced (with custom path option) and scoped routes support

Aperta
#257 7 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Ruby
Stelle
2.3k
Fork
546
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

My API endpoints are defined like that:

namespace :api, path: '' do
  scope ':customer' do
    api_version(module: 'V1', header: { ... }) do # versionist gem
      jsonapi_resources :users
    end
  end
end

This ends up with routes looking like:
/:customer/users/:id
but JR returns self links like:
/api/v1/users/:id

I managed to fixing that by monkey-patching JSONAPI::ResourceSerializer with:

module JSONAPI
  class ResourceSerializer
    def formatted_module_path(source)
      "#{currrent_customer}/"
    end
  end
end

but it's less than ideal. It would be nice to have a proper support for custom routes.

It could be fixed by #159 maybe.

Thanks!

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con JSONAPI::ResourceSerializer e il suo metodo formatted_module_path, che l'issue identifica come l'attuale soluzione alternativa. Esamina le route di namespace e scope personalizzate nell'esempio e nell'issue #159, quindi verifica che i self link generati corrispondano al percorso /:customer/users/:id definito dal routing senza monkey-patching.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
rails, ruby
Ambito
api
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.