Sha256: f8fb1373a70b0706432acfcf00e14c8094afc56ad6c2231d8edc8fc0968fc964
Contents?: true
Size: 1.54 KB
Versions: 1
Compression:
Stored size: 1.54 KB
Contents
# Grape::FastJsonapi Use [fast_jsonapi](https://github.com/Netflix/fast_jsonapi) with [Grape](https://github.com/ruby-grape/grape). ## Installation Add the `grape` and `grape_fast_jsonapi` gems to Gemfile. ```ruby gem 'grape' gem 'grape_fast_jsonapi' ``` ## Usage ### Tell your API to use Grape::Formatter::FastJsonapi ```ruby class API < Grape::API content_type :jsonapi, "application/vnd.api+json" formatter :json, Grape::Formatter::FastJsonapi formatter :jsonapi, Grape::Formatter::FastJsonapi end ``` ### Use `render` to specify JSONAPI options ```ruby get "/" do user = User.find("123") render user, include: [:account] end ``` ### Model parser for response documentation When using Grape with Swagger via [grape-swagger](https://github.com/ruby-grape/grape-swagger), you can generate response documentation automatically via the provided following model parser: ```ruby # FastJsonapi serializer example # app/serializers/user_serializer.rb class UserSerializer include FastJsonapi::ObjectSerializer set_type :user has_many :orders attributes :name, :email end # config/initializers/grape_swagger.rb GrapeSwagger.model_parsers.register(GrapeSwagger::FastJsonapi::Parser, UserSerializer) # Your grape API endpoint desc 'Get current user', success: { code: 200, model: UserSerializer, message: 'The current user' } # [...] ``` Note that you **need** the `grape-swagger` gem for this to work, otherwise it will throw an error. ## Credit Code adapted from [grape-jsonapi-resources](https://github.com/cdunn/grape-jsonapi-resources)
Version data entries
1 entries across 1 versions & 1 rubygems
Version | Path |
---|---|
grape_fast_jsonapi-0.2.1 | README.md |