jsonapi v1.3.0 JSONAPI.Serializer View Source
Serialize a map of data into a properly formatted JSON API response object
Link to this section Summary
Functions
Takes a view, data and a optional plug connection and returns a fully JSONAPI Serialized document. This assumes you are using the JSONAPI.View and have data in maps or structs.
Link to this section Functions
Link to this function
encode_relationships(conn, doc, view_info, options)
View Sourceencode_relationships(Plug.Conn.t(), serialized_doc(), tuple(), list()) :: tuple()
Link to this function
serialize(view, data, conn \\ nil, meta \\ nil, options \\ [])
View Sourceserialize(module(), term(), Plug.Conn.t() | nil, map() | nil, list()) :: serialized_doc()
Takes a view, data and a optional plug connection and returns a fully JSONAPI Serialized document. This assumes you are using the JSONAPI.View and have data in maps or structs.
Please refer to JSONAPI.View
for more information. If you are in interested in relationships
and includes you may also want to reference the JSONAPI.QueryParser
.