/spring-hateoas-examples

Collection of examples on how to build hypermedia-driven apps with Spring HATEOAS

Primary LanguageJavaApache License 2.0Apache-2.0

Spring HATEOAS Examples

icon?job=spring hateoas examples%2Fmaster&subject=master icon?job=spring hateoas examples%2F0.x&subject=0

This repository contains example projects to interact with Spring HATEOAS.

  • Learn how to interact with a Spring HATEOAS-powered app, from inside as well as the command line.

  • See how to upgrade a REST resource without having to create new media types, version URIs, etc.

We have separate folders for each of these:

Spring HATEOAS Modules

  • Basics - Poke and prod at a hypermedia-powered service from inside the code as well as externally using standard tools

  • Simplified - Use Spring HATEOAS in the simplest way possible.

  • API Evolution - Upgrade an existing REST resource

  • Hypermedia - Create hypermedia-driven REST resources, linking them together, and supporting older links.

  • Affordances - Create richer hypermedia controls using more complex hypermedia formats

Note
 The master branch tracks Spring HATEOAS 1.0, based upon Spring Boot 2 + Spring Framework 5. To see examples depicted against the 0.x branch (Spring 4.x) visit the 0.x branch.

Making a release

  1. Create a new release (on the main branch).

    % ci/create-release.sh <release version> <next snapshot version>

  2. With the release tagged, push the tagged version to the release branch.

    % git checkout -b release
% git reset --hard <tag>
% git push -f origin release
Note
 You can chain the previous set of commands together using &&.

The pipeline will build and release the "release" branch. It will also build a new a new snapshot and stage it on artifactory.