https://github.com/mikekelly/hal_specification

HAL Specification
https://github.com/mikekelly/hal_specification

Last synced: 3 months ago
JSON representation

HAL Specification

• Host: GitHub
• URL: https://github.com/mikekelly/hal_specification
• Owner: mikekelly
• Created: 2011-10-30T09:18:52.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2023-10-30T12:35:40.000Z (about 1 year ago)
• Last Synced: 2024-08-01T12:18:31.804Z (6 months ago)
• Language: CSS
• Homepage: http://stateless.co/hal_specification.html
• Size: 133 KB
• Stars: 619
• Watchers: 60
• Forks: 57
• Open Issues: 18
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-starred - mikekelly/hal_specification - HAL Specification (others)

README

        
# HAL - Hypertext Application Language

## A lean hypermedia type

HAL is a simple way of linking with JSON or XML.

It provides a small set of conventions on top of JSON and XML for

expressing hyperlinks to, and embeddedness of, related resources.

The spec is here: [hal\_specification.md][1].

For a friendlier, more practical introduction to HAL you can read this

article: [JSON Linking with HAL][2].

The JSON variant of HAL (application/hal+json) has now been published as

an internet draft:

[draft-kelly-json-hal][5].

## Discussion Group

If you have any questions or feedback about HAL, you can message the

[HAL-discuss mailing list][3].

## Contributing

If you think some part of the spec needs changing, just fork this repo

and raise a pull request with your changes.

## Code/Libraries

hal_specification.md contains [a list of libraries for working with HAL][4].

 [1]: https://github.com/mikekelly/hal_specification/blob/master/hal_specification.md

 [2]: http://blog.stateless.co/post/13296666138/json-linking-with-hal

 [3]: http://groups.google.com/group/hal-discuss

 [4]: https://github.com/mikekelly/hal_specification/wiki/Libraries

 [5]: http://tools.ietf.org/html/draft-kelly-json-hal