Table of Contents - joyful_jsonapi-0.0.2 Documentation
Pages
- LICENSE
-
README
- Joyful JSON API
- Performance Comparison
- Benchmark times for 250 records
- Table of Contents
- Features
- Installation
- Usage
- Rails Generator
- Model Definition
- Serializer Definition
- Sample Object
- Object Serialization
- Return a hash
- Return Serialized JSON
- Serialized Output
- Key Transforms
- Attributes
- Links Per Object
- Links on a Relationship
- Meta Per Resource
- Compound Document
- Collection Serialization
- Control Over Collection Serialization
- Caching
- Params
- Conditional Attributes
- Conditional Relationships
- Sparse Fieldsets
- Using helper methods
- Using ActiveSupport::Concern
- Using Plain Old Ruby
- Customizable Options
- Parsing Incoming Params
- Instrumentation
- Contributing
- Running Tests
- USAGE
- serializer.rb.tt
Classes and Modules
- JoyfulJsonapi
- JoyfulJsonapi::Attribute
- JoyfulJsonapi::ErrorSerializer
- JoyfulJsonapi::Instrumentation
- JoyfulJsonapi::Instrumentation::Skylight
- JoyfulJsonapi::Instrumentation::Skylight::Normalizers
- JoyfulJsonapi::Instrumentation::Skylight::Normalizers::SerializableHash
- JoyfulJsonapi::Instrumentation::Skylight::Normalizers::SerializedJson
- JoyfulJsonapi::Link
- JoyfulJsonapi::MultiToJson
- JoyfulJsonapi::MultiToJson::Result
- JoyfulJsonapi::ObjectSerializer
- JoyfulJsonapi::ParameterParser
- JoyfulJsonapi::Parameters
- JoyfulJsonapi::Relationship
- JoyfulJsonapi::SerializationCore
- Object
- Railtie
- SerializerGenerator
Methods
- ::define_accessors — Object
- ::define_to_json — JoyfulJsonapi::MultiToJson
- ::logger — JoyfulJsonapi::MultiToJson
- ::new — JoyfulJsonapi::Attribute
- ::new — JoyfulJsonapi::ErrorSerializer
- ::new — JoyfulJsonapi::Link
- ::new — JoyfulJsonapi::MultiToJson::Result
- ::new — JoyfulJsonapi::Parameters
- ::new — JoyfulJsonapi::Relationship
- ::new — JoyfulJsonapi::ObjectSerializer
- ::reset_to_json! — JoyfulJsonapi::MultiToJson
- ::to_json — JoyfulJsonapi::MultiToJson
- ::to_json_method — JoyfulJsonapi::MultiToJson
- #add_links_hash — JoyfulJsonapi::Relationship
- #add_relationship — JoyfulJsonapi::ObjectSerializer
- #attributes — JoyfulJsonapi::ObjectSerializer
- #attributes_hash — JoyfulJsonapi::SerializationCore
- #attributes_names — SerializerGenerator
- #belongs_to — JoyfulJsonapi::ObjectSerializer
- #build_hash_for — JoyfulJsonapi::ErrorSerializer
- #build_hashes_for — JoyfulJsonapi::ErrorSerializer
- #cache_options — JoyfulJsonapi::ObjectSerializer
- #compute_id_method_name — JoyfulJsonapi::ObjectSerializer
- #compute_serializer_name — JoyfulJsonapi::ObjectSerializer
- #create_relationship — JoyfulJsonapi::ObjectSerializer
- #create_serializer_file — SerializerGenerator
- #deep_symbolize — JoyfulJsonapi::ObjectSerializer
- #errors_for — JoyfulJsonapi::ErrorSerializer
- #extract_attributes — JoyfulJsonapi::Parameters
- #extract_relationships — JoyfulJsonapi::Parameters
- #fetch_associated_object — JoyfulJsonapi::Relationship
- #fetch_id — JoyfulJsonapi::Relationship
- #fetch_polymorphic_option — JoyfulJsonapi::ObjectSerializer
- #finalize — JoyfulJsonapi::Parameters
- #get_included_records — JoyfulJsonapi::SerializationCore
- #has_many — JoyfulJsonapi::ObjectSerializer
- #has_one — JoyfulJsonapi::ObjectSerializer
- #hash_for_collection — JoyfulJsonapi::ObjectSerializer
- #hash_for_one_record — JoyfulJsonapi::ObjectSerializer
- #id_from_record — JoyfulJsonapi::SerializationCore
- #id_hash — JoyfulJsonapi::Relationship
- #id_hash — JoyfulJsonapi::SerializationCore
- #id_hash_from_record — JoyfulJsonapi::Relationship
- #ids_hash — JoyfulJsonapi::Relationship
- #ids_hash_from_record_and_relationship — JoyfulJsonapi::Relationship
- #include_attribute? — JoyfulJsonapi::Attribute
- #include_relationship? — JoyfulJsonapi::Relationship
- #inherited — JoyfulJsonapi::ObjectSerializer
- #is_collection? — JoyfulJsonapi::ObjectSerializer
- #link — JoyfulJsonapi::ObjectSerializer
- #links_hash — JoyfulJsonapi::SerializationCore
- #meta — JoyfulJsonapi::ObjectSerializer
- #meta_hash — JoyfulJsonapi::SerializationCore
- #normalize — JoyfulJsonapi::Instrumentation::Skylight::Normalizers::SerializableHash
- #normalize — JoyfulJsonapi::Instrumentation::Skylight::Normalizers::SerializedJson
- #ok? — JoyfulJsonapi::MultiToJson::Result
- #parse_include_item — JoyfulJsonapi::SerializationCore
- #populate_root_key — JoyfulJsonapi::Parameters
- #process_options — JoyfulJsonapi::ObjectSerializer
- #rails_attribute_hash — JoyfulJsonapi::Parameters
- #record_hash — JoyfulJsonapi::SerializationCore
- #reflected_record_type — JoyfulJsonapi::ObjectSerializer
- #relationships_hash — JoyfulJsonapi::SerializationCore
- #remaining_items — JoyfulJsonapi::SerializationCore
- #rescue — JoyfulJsonapi::MultiToJson::Result
- #run_key_transform — JoyfulJsonapi::Relationship
- #run_key_transform — JoyfulJsonapi::ObjectSerializer
- #serializable_hash — JoyfulJsonapi::ErrorSerializer
- #serializable_hash — JoyfulJsonapi::ObjectSerializer
- #serializable_hash_without_instrumentation — JoyfulJsonapi::ObjectSerializer
- #serialize — JoyfulJsonapi::Attribute
- #serialize — JoyfulJsonapi::Link
- #serialize — JoyfulJsonapi::Relationship
- #serialized_json — JoyfulJsonapi::ErrorSerializer
- #serialized_json — JoyfulJsonapi::ObjectSerializer
- #serialized_json_without_instrumentation — JoyfulJsonapi::ObjectSerializer
- #set_id — JoyfulJsonapi::ObjectSerializer
- #set_key_transform — JoyfulJsonapi::ObjectSerializer
- #set_type — JoyfulJsonapi::ObjectSerializer
- #to_action_controller_params — JoyfulJsonapi::Parameters
- #to_hash — JoyfulJsonapi::ObjectSerializer
- #to_json — JoyfulJsonapi::SerializationCore
- #translate_jsonapi_params — JoyfulJsonapi::ParameterParser
- #type_key — JoyfulJsonapi::Parameters
- #use_hyphen — JoyfulJsonapi::ObjectSerializer
- #validate_includes! — JoyfulJsonapi::ObjectSerializer
- #value! — JoyfulJsonapi::MultiToJson::Result