Table of Contents - dulead-jsonapi-serializer-2.2.2 Documentation
Pages
- LICENSE
-
README
- JSON:API Serialization Library
- :warning: :construction: At the moment, contributions are welcome only for v3! :construction: :warning:
- Performance Comparison
- Table of Contents
- Features
- Installation
- Usage
- Rails Generator
- Model Definition
- Serializer Definition
- Sample Object
- Object Serialization
- Return a hash
- Return Serialized JSON
- Serialized Output
- The Optionality of
set_type
- Key Transforms
- Attributes
- Links Per Object
- Links on a Relationship
- Meta Per Resource
- Meta on a Relationship
- Compound Document
- Collection Serialization
- Control Over Collection Serialization
- Caching
- Caching and Sparse Fieldsets
- Params
- Conditional Attributes
- Conditional Relationships
- Specifying a Relationship Serializer
- Sparse Fieldsets
- Using helper methods
- Using ActiveSupport::Concern
- Using Plain Old Ruby
- Customizable Options
- Performance Instrumentation
- Running Tests
- Deserialization
- JSONAPI.rb
- Migrating from Netflix/fast_jsonapi
- Modify your Gemfile
- Replace all constant references
- Replace removed methods
- Replace require references
- Update your cache options
- Contributing
- USAGE
- serializer.rb.tt
Classes and Modules
- FastJsonapi
- FastJsonapi::Attribute
- FastJsonapi::Link
- FastJsonapi::ObjectSerializer
- FastJsonapi::Relationship
- FastJsonapi::Scalar
- FastJsonapi::SerializationCore
- JSONAPI
- JSONAPI::Serializer
- JSONAPI::Serializer::Error
- JSONAPI::Serializer::Instrumentation
- JSONAPI::Serializer::UnsupportedIncludeError
- Object
- Railtie
- SerializerGenerator
Methods
- ::call_proc — FastJsonapi
- ::define_accessors — Object
- ::included — JSONAPI::Serializer
- ::new — FastJsonapi::Relationship
- ::new — FastJsonapi::Scalar
- ::new — JSONAPI::Serializer::UnsupportedIncludeError
- ::new — FastJsonapi::ObjectSerializer
- #add_links_hash — FastJsonapi::Relationship
- #add_meta_hash — FastJsonapi::Relationship
- #add_relationship — FastJsonapi::ObjectSerializer
- #attributes — FastJsonapi::ObjectSerializer
- #attributes_hash — FastJsonapi::SerializationCore
- #attributes_names — SerializerGenerator
- #belongs_to — FastJsonapi::ObjectSerializer
- #cache_options — FastJsonapi::ObjectSerializer
- #compute_id_method_name — FastJsonapi::ObjectSerializer
- #compute_static_record_type — FastJsonapi::Relationship
- #compute_static_serializer — FastJsonapi::Relationship
- #conditionally_allowed? — FastJsonapi::Scalar
- #create_relationship — FastJsonapi::ObjectSerializer
- #create_serializer_file — SerializerGenerator
- #deep_symbolize — FastJsonapi::ObjectSerializer
- #deprecated_cache_options — FastJsonapi::ObjectSerializer
- #fetch_associated_object — FastJsonapi::Relationship
- #fetch_id — FastJsonapi::Relationship
- #fetch_polymorphic_option — FastJsonapi::ObjectSerializer
- #get_included_records — FastJsonapi::SerializationCore
- #has_many — FastJsonapi::ObjectSerializer
- #has_one — FastJsonapi::ObjectSerializer
- #hash_for_collection — FastJsonapi::ObjectSerializer
- #hash_for_one_record — FastJsonapi::ObjectSerializer
- #id_from_record — FastJsonapi::SerializationCore
- #id_hash — FastJsonapi::Relationship
- #id_hash — FastJsonapi::SerializationCore
- #id_hash_from_record — FastJsonapi::Relationship
- #ids_hash — FastJsonapi::Relationship
- #ids_hash_from_record_and_relationship — FastJsonapi::Relationship
- #include_relationship? — FastJsonapi::Relationship
- #inherited — FastJsonapi::ObjectSerializer
- #initialize_static_serializer — FastJsonapi::Relationship
- #is_collection? — FastJsonapi::ObjectSerializer
- #link — FastJsonapi::ObjectSerializer
- #links_hash — FastJsonapi::SerializationCore
- #message — JSONAPI::Serializer::UnsupportedIncludeError
- #meta — FastJsonapi::ObjectSerializer
- #meta_hash — FastJsonapi::SerializationCore
- #parse_includes_list — FastJsonapi::SerializationCore
- #process_options — FastJsonapi::ObjectSerializer
- #record_cache_options — FastJsonapi::SerializationCore
- #record_hash — FastJsonapi::SerializationCore
- #record_type_for — FastJsonapi::Relationship
- #reflected_record_type — FastJsonapi::ObjectSerializer
- #relationships_hash — FastJsonapi::SerializationCore
- #run_key_transform — FastJsonapi::Relationship
- #run_key_transform — FastJsonapi::ObjectSerializer
- #serializable_hash — FastJsonapi::ObjectSerializer
- #serialize — FastJsonapi::Relationship
- #serialize — FastJsonapi::Scalar
- #serializer_for — FastJsonapi::Relationship
- #serializer_for — FastJsonapi::ObjectSerializer
- #serializer_for_name — FastJsonapi::Relationship
- #set_id — FastJsonapi::ObjectSerializer
- #set_key_transform — FastJsonapi::ObjectSerializer
- #set_record_type_block — FastJsonapi::ObjectSerializer
- #set_type — FastJsonapi::ObjectSerializer
- #static_record_type — FastJsonapi::Relationship
- #static_serializer — FastJsonapi::Relationship
- #to_hash — FastJsonapi::ObjectSerializer
- #type_from_record — FastJsonapi::SerializationCore
- #use_hyphen — FastJsonapi::ObjectSerializer
- #validate_includes! — FastJsonapi::ObjectSerializer