JSON API client API

client.ex

defmodule SomeAPI.Client do
  use JSONAPIClient
  host "https://example.com"
  namespace "api/v1"
  
  register_type :users, SomeAPI.User
  register_type :orgs, SomeAPI.Org
end

org.ex

defmodule SomeAPI.Org do
  use JSONAPIClient.Resource
  attribute :name
  relationship :users
end

usage.ex

# Linked relationship
users = SomeAPI.Client.get(:users, page: 1)
user = Enum.at users, 0
user.orgs
# => %JSONAPI.RelationshipNotLoaded{}

user = SomeAPI.Client.load_relationship(user[0], :org)
user.orgs
# => [%SomeAPI.Org{}]

user.name
# => Jane Doe

# Sideloaded relationship
users = SomeAPI.Client.get(:users, page: 1)
user = Enum.at users, 0
user.orgs
# => [%SomeAPI.Org{}]

user.ex

defmodule SomeAPI.User do
  use JSONAPIClient.Resource
  attribute :name
  relationship :orgs
end