Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add node.js package suggestion

Browse Source
This commit is contained in:
Andrzej
2019-02-21 14:42:28 +01:00
parent dd7093207d
commit fd55e77ffb
1 changed files with 4 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
rest-api-guidelines/functionality/message/hal.md
View File

@@ -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). 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 ## Simple Document Example
The simplest Hal document looks like an empty JSON \(it is an empty JSON!\): 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). 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
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). 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).