netflix / restful-jsonapi

JSONAPI support, both in request parameters, and serialization.

Restful::Jsonapi

A temporary monkeypatch for JSONAPI support, both in request payload, and serializing the type without a namespace.

Installation

Add this line to your application's Gemfile:

gem 'restful-jsonapi'

And then execute:

$ bundle

Or install it yourself as:

$ gem install restful-jsonapi

Usage

class MovieTypesController < ApplicationController

  ...
 
  private

  def movie_type_params
    restify_param(:movie_type).require(:movie_type).permit(
      :id,
      :name,
      created_user: [
        :id,
        :email
      ]
  end
end

Contributing

1. Fork it ( https://github.com/[my-github-username]/restful-jsonapi/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

restful-jsonapi's Issues

supported rails 6 ?

yes !

pls take a look - https://github.com/acceptly/restful-jsonapi/tree/support-rails-6

How do you use restify_params with FormData when uploading files.

Has anyone tried using restify_param when uploading a FormData object so files can be uploaded? I'm having troubles getting this to work.

Tests? Where are they?

We should provide tests.

Doesn't underscore nested data

I'm using this in place of active_model_serializers and I'm noticing one difference with how attributes are transformed. This handles transforming attribute keys to underscore but doesn't handle deeply transforming keys in hashes. This is useful when saving to the Postgres data type json.

Does not handle polymorphic types

For example:

{
  "data" => {
    "attributes" => { ... }, 
    "relationships" => {
      "payable" => {
        "data" => {
          "type" => "orders", 
          "id" => "535"
        }
      }
    }, 
    "type" => "payments"
  }
}

This would give nil for Payment.new(restify_param(:payment).require(:payment).permit(:payable_type, :payable_id).payable

Remove console logs

Is it possible to remove outputs to console?

Extending ActionController::Base with Restful::Jsonapi::RestifyParam
Extending ActionController::Base with Restful::Jsonapi::SerializableErrors
Extending ActionController::API with Restful::Jsonapi::RestifyParam
Extending ActionController::API with Restful::Jsonapi::SerializableErrors

Or make them run under some environment only (such as development)? It's just that having some printouts feels a little clumsy, and I don't really see the use for it...

Which version of AMS is this targeting?

0.8, 0.9, 0.10? Asking in case I can help.

Do not mutate the params passed in

Currently this mutates the params passed into the controller, we should not.