From fd55e77ffb8933d22eaa31c5f2a0afaf5e6a812f Mon Sep 17 00:00:00 2001 From: Andrzej Date: Thu, 21 Feb 2019 14:42:28 +0100 Subject: [PATCH] Add node.js package suggestion --- rest-api-guidelines/functionality/message/hal.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/rest-api-guidelines/functionality/message/hal.md b/rest-api-guidelines/functionality/message/hal.md index 8a2c1da..c7fa1b8 100644 --- a/rest-api-guidelines/functionality/message/hal.md +++ b/rest-api-guidelines/functionality/message/hal.md @@ -12,6 +12,8 @@ This document is an informal introduction to the HAL media type. For more detail HAL document follow the object model defined in JSON-schema [here](https://supermodel.io/adidas/api/HAL). +We provide also YAML code snippets for [OpenAPI Specification 2.0/Swagger](./HAL-snippet.yaml) and [OpenAPI Specification 3.x](./HAL-snippet-full-OpenApi3.yaml). + ## Simple Document Example The simplest Hal document looks like an empty JSON \(it is an empty JSON!\): @@ -117,6 +119,8 @@ Some APIs using HAL: Refer to the [extensive list of libraries that work with HAL](https://github.com/mikekelly/hal_specification/wiki/Libraries). +For working with HAL and Node.js we suggest using [HALson npm package](https://www.npmjs.com/package/halson). + ### Spring Framework Spring framework supports HAL out of the box. More info can be found in [Spring Documentation](https://spring.io/guides/gs/rest-hateoas/) and [examples](https://github.com/spring-guides/gs-rest-hateoas).