https://github.com/spring-projects/spring-hateoas-examples

Collection of examples on how (and why) to build hypermedia-driven apps with Spring HATEOAS
https://github.com/spring-projects/spring-hateoas-examples

hateoas rest spring

Last synced: about 1 month ago
JSON representation

Collection of examples on how (and why) to build hypermedia-driven apps with Spring HATEOAS

• Host: GitHub
• URL: https://github.com/spring-projects/spring-hateoas-examples
• Owner: spring-projects
• License: apache-2.0
• Created: 2017-05-25T18:33:41.000Z (over 7 years ago)
• Default Branch: main
• Last Pushed: 2022-12-30T00:58:41.000Z (almost 2 years ago)
• Last Synced: 2024-09-28T16:41:09.048Z (about 1 month ago)
• Topics: hateoas, rest, spring
• Language: Java
• Homepage:
• Size: 288 KB
• Stars: 379
• Watchers: 16
• Forks: 184
• Open Issues: 15
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.adoc
  • Security: security/pom.xml

Awesome Lists containing this project

README

        
= Spring HATEOAS Examples

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas-examples%2Fmain&subject=main[link=https://jenkins.spring.io/view/SpringHATEOAS/job/spring-hateoas-examples/]

image:https://jenkins.spring.io/buildStatus/icon?job=spring-hateoas-examples%2F0.x&subject=0.x[link=https://jenkins.spring.io/view/SpringHATEOAS/job/spring-hateoas-examples/]

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

* link:basics[Basics] - Poke and prod at a hypermedia-powered service from inside the code as well as externally using standard tools

* link:simplified[Simplified] - Use Spring HATEOAS in the simplest way possible.

* link:api-evolution[API Evolution] - Upgrade an existing REST resource

* link:hypermedia[Hypermedia] - Create hypermedia-driven REST resources, linking them together, and supporting older links.

* link:affordances[Affordances] - Create richer hypermedia controls using more complex hypermedia formats

* link:spring-hateoas-and-spring-data-rest[Spring HATEOAS + Spring Data REST] - How to stir in custom links and logic with a Spring Data REST-based app

NOTE: The main 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 https://github.com/spring-projects/spring-hateoas-examples/tree/0.x[0.x branch].

== Community

The Spring HATEOAS community has its own contributions when it comes to examples of building hypermedia.

* https://github.com/ingogriebsch/spring-hateoas-siren-samples[Siren HATEOAS Examples] - The maintainer of the Siren extension of Spring HATEOAS has an extra set of examples.