league/json-reference

A library for working with JSON References

JSON Reference

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

Unmaintained!

This project is no longer maintained. Recommended alternatives:, _(*2)

• opis/json-schema
• swaggest/php-json-schema

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., _(*3)

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

• 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 league/json-reference

Usage

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

Change log

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

Testing

``` bash $ composer test-server $ composer test, <sub>(*7)</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>(*8)</sub>

Security

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

Credits

• Matt Allan
• All Contributors

License

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