https://github.com/cosium/hal-mock-mvc

MockMvc wrapper allowing to easily test Spring HATEOAS HAL(-FORMS) endpoints
https://github.com/cosium/hal-mock-mvc

hal hal-form hateoas spring-hateoas

Last synced: 3 months ago
JSON representation

MockMvc wrapper allowing to easily test Spring HATEOAS HAL(-FORMS) endpoints

• Host: GitHub
• URL: https://github.com/cosium/hal-mock-mvc
• Owner: Cosium
• License: mit
• Created: 2023-05-20T08:44:52.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2025-02-11T09:03:27.000Z (8 months ago)
• Last Synced: 2025-02-25T20:41:18.616Z (8 months ago)
• Topics: hal, hal-form, hateoas, spring-hateoas
• Language: Java
• Homepage:
• Size: 88.9 KB
• Stars: 6
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![Build Status](https://github.com/Cosium/hal-mock-mvc/actions/workflows/ci.yml/badge.svg)](https://github.com/Cosium/hal-mock-mvc/actions/workflows/ci.yml)

[![Maven Central](https://img.shields.io/maven-central/v/com.cosium.hal_mock_mvc/hal-mock-mvc-spring-boot-starter.svg)](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.cosium.hal_mock_mvc%22%20AND%20a%3A%22hal-mock-mvc-spring-boot-starter%22)

# HAL Mock MVC

MockMvc wrapper allowing to easily test [Spring HATEOAS](https://github.com/spring-projects/spring-hateoas) HAL(-FORMS) endpoints.

# Quick start

1. Add the `spring-boot-starter` dependency:

    ```xml

    

       com.cosium.hal_mock_mvc

       hal-mock-mvc-spring-boot-starter

       ${hal-mock-mvc.version}

       test

    

    ```

2. Annotate your test class with `AutoConfigureHalMockMvc` and inject `HalMockMvc`:

   ```java

   @AutoConfigureHalMockMvc

   @SpringBootTest

   class MyTest {

     @Autowired

     private HalMockMvc halMockMvc;

   

     @Test

     void test() {

       halMockMvc

          .follow("current-user")

          .get()

          .andExpect(status().isOk())

          .andExpect(jsonPath("$.alias").value("jdoe"));

     }

   }

   ```

# Prerequisites

- Java 17+

- Spring dependencies matching Spring Boot 3 and above.

# Genesis

This project was created following https://github.com/spring-projects/spring-hateoas/issues/733 discussion.