JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Namespaced (with custom path option) and scoped routes support

Offen
#257 7 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Ruby
Sterne
2.3k
Forks
546
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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!

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit JSONAPI::ResourceSerializer und seiner formatted_module_path-Methode, die das Issue als aktuelle Umgehungslösung identifiziert. Überprüfen Sie die benutzerdefinierten Namespace- und Scope-Routen im Beispiel und in Issue #159 und verifizieren Sie anschließend, dass die generierten Self-Links ohne Monkey-Patching mit dem gerouteten Pfad /:customer/users/:id übereinstimmen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
rails, ruby
Bereich
api
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.