ja_serializer

v0.18.1

ja_serializer v0.18.1 API Reference

Modules

JaSerializer

A library for generating JSON-API.org spec compliant JSON.

JaSerializer.AssociationNotLoadedError
JaSerializer.Builder.PaginationLinks

Builds JSON-API spec pagination links.

JaSerializer.Builder.ScrivenerLinks

Builds JSON-API spec pagination links for %Scrivener.Page{}.

JaSerializer.Builder.Utils

Utilities to work with building serialized data

JaSerializer.ContentTypeNegotiation

This plug provides content type negotiation by validating the content-type and accept headers.

JaSerializer.DSL

A DSL for defining JSON-API.org spec compliant payloads.

JaSerializer.Deserializer

This plug "deserializes" params to underscores.

JaSerializer.EctoErrorSerializer

The EctoErrorSerializer is used to transform Ecto changeset errors to JSON API standard error objects.

JaSerializer.ErrorSerializer

A super basic wrapper for formatting jsonapi errors.

JaSerializer.Formatter
JaSerializer.ParamParser
JaSerializer.Params

Functions to help when working with json api params.

JaSerializer.PhoenixView

Use in your Phoenix.View to render jsonapi.org spec json.

JaSerializer.Relationship.HasMany

Struct to represent a HasMany relationship.

JaSerializer.Relationship.HasOne

Struct representing a HasOne (or belongs to) relationship.

JaSerializer.ReservedKeywordError
JaSerializer.Serializer

A Behaviour for defining JSON-API.org spec complaint payloads.