JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Namespaced (with custom path option) and scoped routes support

Ouverte
#257 7 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Ruby
Étoiles
2.3k
Forks
546
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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!

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par JSONAPI::ResourceSerializer et sa méthode formatted_module_path, que l’issue identifie comme le contournement actuel. Examinez les routes de namespace et de scope personnalisées dans l’exemple et l’issue #159, puis vérifiez que les self links générés correspondent au chemin /:customer/users/:id défini par le routage, sans monkey-patching.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
rails, ruby
Domaine
api
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.