JSONAPI::Document::Builder::Relationships - Related Resource Document builder
version 1.6
Builds the related resource document for a given row.
The DBIx::Class::Row for relationship.
DBIx::Class::Row
relationship
Note this is not the relationship row, rather it is its parent.
String name of the relationship.
Boolean; Default: false
If specified, will build the relationship with attributes instead of links.
Default behaviour is to build with links.
Main caller method; Builds the related resource document.
Builds a HashRef containing strings that represent URLs for fetching the given relationship, as well as the relationship ID(s).
Builds a HashRef of the relationship(s) with attributes.
Builds a HashRef representing a single relationship row.
To install JSONAPI::Document, copy and paste the appropriate command in to your terminal.
cpanm
cpanm JSONAPI::Document
CPAN shell
perl -MCPAN -e shell install JSONAPI::Document
For more information on module installation, please visit the detailed CPAN module installation guide.