HAL Explorer

HAL Explorer helps you explore HAL- and HAL-FORMS-based RESTful Hypermedia APIs.

Reference Docs and Demos

Release	2.2.1	Reference Documentation	HAL Explorer Demo
Snapshot	2.2.2-SNAPSHOT	Reference Documentation	HAL Explorer Demo

You can also try HAL Explorer online at https://hal-explorer.com.

Screenshots

Dark Mode with Default Theme:

Light Mode with Default Theme:

Features

• Dark/Light/Auto color modes with 26+ Bootstrap themes

• Full HTTP method support (GET, POST, PUT, PATCH, DELETE, OPTIONS)

• HAL-FORMS support with property validation

• Spring Data REST integration with profile detection

• URI template parameter editor

• Custom request headers

• CURIE-based documentation

• Syntax-highlighted JSON responses

See the complete feature list in the documentation.

Backend Integration

WebJar (Java/Spring Boot):

Maven:

<dependency>
    <groupId>org.webjars</groupId>
    <artifactId>hal-explorer</artifactId>
    <version>2.2.1</version>
</dependency>

Gradle (Groovy):

runtimeOnly 'org.webjars:hal-explorer:2.2.1'

Gradle (Kotlin):

runtimeOnly("org.webjars:hal-explorer:2.2.1")

Access at: /webjars/hal-explorer/2.2.1/index.html

For Spring Data REST integration, see the Setup Guide.

Development

Dev Server:

yarn start

Navigate to http://localhost:4200/. The dev server proxies /api and /docs to localhost:8080 (no CORS needed).

Build:

yarn build

Build artifacts are in dist/ directory.

Tests:

yarn test           # unit tests
yarn test:headless  # headless unit tests
yarn e2e            # e2e tests (Playwright)

Code Quality:

• Prettier formatting (auto-format on commit)

• Conventional Commits enforced

• Managed by Husky Git hooks

License

MIT, see http://toedter.mit-license.org