jsonapi v0.9.0 API Reference
Modules
A module for working with the JSON API specification in Elixir
Configuration struct containing JSON API information for a request
Provides content type negotiation by validating the content-type
and accept
headers
Generate warnings in places where we want to deprecate functions or struct parameters
Helper functions for working with Ecto
A helper Plug to enforce the JSON API specification
Enforces the JSONAPI format of {"data" => {"attributes" => ...}} for request bodies
Ensure that the URL id matches the id in the request body and is a string
Configuration struct containing pagination opts for a request
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
Simply add this plug to your endpoint or your router :api pipeline and it will ensure you return the correct response type
Serialize a map of data into a properly formatted JSON API response object
Takes dasherized JSON:API params and turns them into underscored params. Add this to your API's pipeline to aid in dealing with incoming parameters
Internal utility for building trees of resource relationships
String manipulation helpers
DEPRECATED. Please Use JSONAPI.Utils.String
instead
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