https://github.com/otto-de/edison-hal

A library to parse and render application/hal+json documents in Java
https://github.com/otto-de/edison-hal

Last synced: about 2 months ago
JSON representation

A library to parse and render application/hal+json documents in Java

• Host: GitHub
• URL: https://github.com/otto-de/edison-hal
• Owner: otto-de
• License: apache-2.0
• Created: 2016-07-21T13:03:29.000Z (about 8 years ago)
• Default Branch: main
• Last Pushed: 2023-11-28T00:44:43.000Z (10 months ago)
• Last Synced: 2024-07-11T11:55:07.599Z (2 months ago)
• Language: Java
• Size: 916 KB
• Stars: 40
• Watchers: 16
• Forks: 10
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - otto-de/edison-hal - A library to parse and render application/hal+json documents in Java (Java)

README

        
# Edison HAL

Library to produce and consume [application/hal+json](https://tools.ietf.org/html/draft-kelly-json-hal-08) 

representations of REST resources using Jackson.

[![Build Status](https://travis-ci.org/otto-de/edison-hal.svg)](https://travis-ci.org/otto-de/edison-hal) 

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/de.otto.edison/edison-hal/badge.svg)](https://maven-badges.herokuapp.com/maven-central/de.otto.edison/edison-hal)

[![Javadoc](https://www.javadoc.io/badge/de.otto.edison/edison-hal.svg)](https://www.javadoc.io/doc/de.otto.edison/edison-hal)

[![codecov](https://codecov.io/gh/otto-de/edison-hal/branch/master/graph/badge.svg)](https://codecov.io/gh/otto-de/edison-hal)

## 1. Documentation

* [JavaDoc](https://www.javadoc.io/doc/de.otto.edison/edison-hal)

* [User Guide](./USERGUIDE.md) explains how to use edison-hal in your projects.

* [Change Log](./CHANGES.md) for latest changes.

## 2. About

At otto.de, microservices should only communicate via REST APIs with other 

 microservices. HAL is a nice format to implement the HATEOAS part 

 of REST. Edison-HAL is a library to make it easy to produce

 and consume HAL representations for your REST APIs.

Currently, there are only a couple of libraries supporting HAL and even

 less that support the full media type including all link properties,

 curies (compact URIs) and embedded resources.

 

Spring HATEOAS, for example, is lacking many link properties, such as 

 title, name, type and others. 

## 3. Features

Creating HAL representations:

* Links with all specified attributes like rel, href, profile, type, name, title, etc. pp.

* Embedded resources, even deeply nested

* Curies in links and embedded resources

* Generation of HAL representations using Jackson annotations

Parsing HAL representations:

* Mapping application/hal+json to Java classes using Jackson. This also works for deeply nested embedded items.

* Simple domain model to access links, embedded resources etc.

* Curies are automatically resolved: Given a curi with name=ex and href=http://example.com/rels/{rel}, links

and embedded items can be access either in curied format `ex:foo`, or expanded format `http://exampl.com/rels/foo` 

Traversion of HAL representations:

* Simple client-side navigation through linked and embedded REST resources using

Traverson API

* Embedded resources are transparantly used, if present. 

* Curies are resolved transparantly, too. Clients of the Traverson API do not need to 

know anything about curies or embedded resources.