This repository has been archived by the owner. It is now read-only.
A library for working with JSON References.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src
tests
.editorconfig
.gitattributes
.gitignore
.scrutinizer.yml
.travis.yml
CHANGELOG.md
CONTRIBUTING.md
LICENSE.md
README.md
composer.json
phpbench.json
phpunit.xml.dist

README.md

JSON Reference

Software License Build Status Coverage Status Quality Score Documentation

Unmaintained!

This project is no longer maintained. Recommended alternatives:


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.

JSON Reference is a library for resolving references.

  • 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.

Change log

Please see CHANGELOG for more information about what has changed recently.

Testing

$ composer test-server
$ composer test

Benchmarks

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

$ composer bench

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email matthew.james.allan@gmail.com instead of using the issue tracker.

Credits

License

The MIT License (MIT). Please see License File for more information.