HAL for humans

Create clients for HAL-based APIs with ease and without compromise.

Find more on:

With halchemy when building your client makes it easier to operate HAL based APIs.

Instead of doing this...

order = {
    'orderNumber': '12345',
    'partNumber': '009343-12',
    'quantity': 3
}  

# the _links all have relative hrefs, but requests needs an absolute URL
orders_url = urljoin(api_url, customer['_links']['orders']['href'])

# We need to convert the order dict to a JSON string
# and supply the Content-type header
requests.post(update_url, json.dumps(order), 
              headers={'Content-type': 'application/json'})

order = {
    orderNumber: '12345',
    partNumber: '009343-12',
    quantity: 3
} 
// assuming axios.defaults.baseURL has been set to the API root URL
axios.post(customer._links.orders.href, order, { 
    headers: { 'Content-type': 'application/json' } 
})

order = {
  "orderNumber" => "12345",
  "partNumber" => "009343-12",
  "quantity" => 3
}

# the _links all have relative hrefs, but HTTPX needs an absolute URL
def url_join(base, path)
  [base.chomp("/"), path.sub(%r{\A/+}, "")].join("/")
end

url = url_join(api_url, customer["_links"]["orders"]["href"])
HTTPX.with(headers: headers).post(url, json: order)

...with halchemy you can do this:

order = {
    'orderNumber': '12345',
    'partNumber': '009343-12',
    'quantity': 3
}  

api.follow(customer).to('orders').post(order)

order = {
    orderNumber: '12345',
    partNumber: '009343-12',
    quantity: 3
} 

api.follow(customer).to('orders').post(order)

order = {
  "orderNumber" => "12345",
  "partNumber" => "009343-12",
  "quantity" => 3
}

api.follow(customer).to("orders").post(order)

Click here to learn more.