Syntax highlighted response body
Custom request headers
2 layouts (2 columns or 3 columns for the documentation)
API URL, theme, layout and request headers stored in URL fragment
Support for Spring Data Rest profiles to populate properties in request editor
Support for HAL-FORMS (_templates) to populate properties in request editor and to provide only supported HTTP methods for self/target link
HAL-FORMS property constraint validation in request editor
yarn start for a dev server. Navigate to http://localhost:4200/.
The app will automatically reload if you change any of the source files.
yarn build to build the project in production mode. The build artifacts will be stored in the
Gradle/Java Build Support
If you have Java installed, you can also build the project with Gradle.
The Gradle build will install node.js locally in the project directory.
./gradlew build to build the project in production mode.
The build artifacts will be stored in the
Integration in your Backends
If you want to use a released version of HAL Explorer in a Java based project, you could define a dependency to the HAL Explorer WebJar.
<dependency> <groupId>org.webjars</groupId> <artifactId>hal-explorer</artifactId> <version>0.14.0</version> </dependency>
When you use the WebJar with Spring Boot, you can access the HAL Explorer at
The easiest way to integrate the upstream version of HAL Explorer into your backend would be to clone this Git repo,
do a production build and then copy the content of the dist folder to a location accessible by your backend server.
When you use Spring Boot, a good location in your projects source tree would be
yarn testto run the unit test suite against your default browser.
yarn test-headlessto run the unit test suite against headless Chrome.
yarn e2eto run the e2e test suite against your default browser.
yarn e2e-headlessto run the e2e test suite against headless Chrome.
Take a look at
package.json for more test options.
MIT, see http://toedter.mit-license.org