Sha256: a25bfae6901af488ca4cbe748c46f4774e90c23b8bf5c1f011df662bd5b097e0

Contents?: true

Size: 920 Bytes

Versions: 9

Compression:

Stored size: 920 Bytes

Contents

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

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

9 entries across 9 versions & 1 rubygems

Version Path
pact_broker-1.3.2.rc1 vendor/hal-browser/README.md
pact_broker-1.3.1 vendor/hal-browser/README.md
pact_broker-1.3.0 vendor/hal-browser/README.md
pact_broker-1.2.0 vendor/hal-browser/README.md
pact_broker-1.1.0 vendor/hal-browser/README.md
pact_broker-1.0.0 vendor/hal-browser/README.md
pact_broker-1.0.0.alpha3 vendor/hal-browser/README.md
pact_broker-1.0.0.alpha2 vendor/hal-browser/README.md
pact_broker-1.0.0.alpha1 vendor/hal-browser/README.md