jsonapi v0.5.0 API Reference

Modules

A module for working with the JSON API specification in Elixir

Configuration struct containing JSON API information for a request

Helper functions for working with Ecto

Simply add this plug to your endpoint or your router :api pipeline and it will ensure you return the correct response type

Implements a fully JSONAPI V1 spec for parsing a complex query string and returning elixir datastructures. The purpose is to validate and encode incoming queries and fail quickly

Serialize a map of data into a properly formatted JSON API response object

Internal utility for building trees of resource relationships

A View is simply a module that defines certain callbacks to configure proper rendering of your JSONAPI documents

Exceptions

Defines a generic exception for when an invalid query is recieved and is unable to be parsed nor handlded