Sha256: 3b45c817fc61fbbf73df13df03e1f6a2963658410fdeb2f951b97997f08ca8cf

Contents?: true

Size: 1.08 KB

Versions: 120

Compression:

Stored size: 1.08 KB

Contents

HAL-browser
===========
An API browser for the hal+json media type

Example Usage
=============
Here is an example of a hal+json API using the browser:

[http://haltalk.herokuapp.com/explorer/browser.html](http://haltalk.herokuapp.com/explorer/browser.html)

About HAL
========
HAL is a format based on json that establishes conventions for
representing links. For example:

```javascript
{
    "_links": {
        "self": { "href": "/orders" },
        "next": { "href": "/orders?page=2" }
    }
}
```

More detail about HAL can be found at
[http://stateless.co/hal_specification.html](http://stateless.co/hal_specification.html).

Instructions
============
All you should need to do is copy the files into your webroot.
It is OK to put it in a subdirectory; it does not need to be in the root.

All the JS and CSS dependencies come included in the vendor directory.


TODO
===========
* Make Location and Content-Location headers clickable links
* Provide feedback to user when there are issues with response (missing
self link, wrong media type identifier)
* Give 'self' and 'curies' links special treatment

Version data entries

120 entries across 120 versions & 1 rubygems

Version Path
pact_broker-2.53.0 vendor/hal-browser/README.md
pact_broker-2.52.2 vendor/hal-browser/README.md
pact_broker-2.52.1 vendor/hal-browser/README.md
pact_broker-2.52.0 vendor/hal-browser/README.md
pact_broker-2.51.0 vendor/hal-browser/README.md
pact_broker-2.50.1 vendor/hal-browser/README.md
pact_broker-2.50.0 vendor/hal-browser/README.md
pact_broker-2.49.0 vendor/hal-browser/README.md
pact_broker-2.48.0 vendor/hal-browser/README.md
pact_broker-2.47.1 vendor/hal-browser/README.md
pact_broker-2.47.0 vendor/hal-browser/README.md
pact_broker-2.46.0 vendor/hal-browser/README.md
pact_broker-2.45.0 vendor/hal-browser/README.md
pact_broker-2.44.0 vendor/hal-browser/README.md
pact_broker-2.43.0 vendor/hal-browser/README.md
pact_broker-2.42.0 vendor/hal-browser/README.md
pact_broker-2.41.0 vendor/hal-browser/README.md
pact_broker-2.40.0 vendor/hal-browser/README.md
pact_broker-2.39.0 vendor/hal-browser/README.md
pact_broker-2.38.1 vendor/hal-browser/README.md