activerules/json-reference

A library for working with JSON References

JSON Reference

![Software License][ico-license] ![Coverage Status][ico-scrutinizer] ![Documentation][ico-docs], _(*1)

NOTE:

This was forked from the referencer written by The PHP League., _(*2)

Our only change is to support "psuedo-relative" paths., _(*3)

Example:, _(*4)

{ "$ref": "file://./address.json" }

The psuedo-relative paths are resolved relative to a defined root directory., _(*5)

That root directory is defined by the AR_JSON_SCHEMA_DIR ENV variable. If that is NOT defined the code uses a schema directory relative to the current working directory as the root., _(*6)

The Basics

Most JSON schemas use JSON references to minimize duplication. A JSON reference is an object that looks like {"$ref": "http://some/where"} and points to a JSON object somewhere else., _(*7)

JSON Reference is a library for resolving references., _(*8)

• Resolves all references, replacing them with proxy objects.
• Supports references to external files, urls, or custom sources.
• Safely resolves circular references.
• Supports caching dereferenced schemas.
• Dereferenced schemas can be safely json_encoded.
• Works with Swagger, JSON Schema, and any other spec compliant JSON documents.

Install

Via Composer

composer require activerules/json-reference

Usage

Our changes shouldn't change the behavior of the dereferenced files so all of the original documentation should be applicable., _(*9)

Complete documentation is available here., _(*10)

Change log

Please see CHANGELOG for more information about what has changed recently., _(*11)

Testing

``` bash $ composer test-server $ composer test, <sub>(*12)</sub>

## Benchmarks

The benchmarks require a local redis server to be running on localhost at the default port.

```bash
$ composer bench

Contributing

Please see CONTRIBUTING for details., <sub>(*13)</sub>

Security

If you discover any security related issues, please email bwinkers@gmail.com instead of using the issue tracker., <sub>(*14)</sub>

Credits

• Matt Allan
• All Contributors

License

The MIT License (MIT). Please see License File for more information., <sub>(*15)</sub>

Sponsored By:

UltriNet, <sub>(*16)</sub>