activerules / json-reference
用于处理 JSON 引用的库
1.1.1
2017-11-23 22:05 UTC
Requires
- php: >=5.6.0
- psr/simple-cache: ^1.0
- sabre/uri: ^1.2.1
Requires (Dev)
- ext-curl: *
- cache/array-adapter: ^0.4.2
- cache/predis-adapter: ^0.4.0
- cache/simple-cache-bridge: ^0.1.0
- phpbench/phpbench: ^0.13.0
- phpunit/phpunit: ^5.7
- scrutinizer/ocular: ~1.1
- squizlabs/php_codesniffer: ~2.3
This package is not auto-updated.
Last update: 2024-09-29 05:14:43 UTC
README
注意
此项目是从 The PHP League 编写的 referencer 分支出来的。
我们的唯一更改是支持“伪相对”路径。
示例
{ "$ref": "file://./address.json" }
伪相对路径是相对于定义的根目录解析的。
该根目录由环境变量 AR_JSON_SCHEMA_DIR
定义。如果没有定义,则代码使用相对于当前工作目录的 schema
目录作为根。
基础知识
大多数 JSON 模式使用 JSON 引用来最小化重复。JSON 引用是一个看起来像 <{"$ref": "http://some/where"} 的对象,并指向其他地方的 JSON 对象。
JSON 引用是一个用于解析引用的库。
- 解析所有引用,并用代理对象替换它们。
- 支持对外部文件、URL 或自定义来源的引用。
- 安全地解析循环引用。
- 支持缓存解除引用的模式。
- 解除引用的模式可以被安全地 json_encoded。
- 与 Swagger、JSON Schema 以及任何其他符合规范的 JSON 文档一起工作。
安装
通过 Composer
composer require activerules/json-reference
用法
我们的更改不应改变解除引用文件的行为,因此所有原始文档都应适用。
完整文档可在此处找到。
变更日志
请参阅 CHANGELOG 了解最近更改的详细信息。
测试
$ composer test-server
$ composer test
基准测试
基准测试需要本地 redis 服务器在 localhost 的默认端口上运行。
$ composer bench
贡献
请参阅 CONTRIBUTING 了解详细信息。
安全性
如果您发现任何与安全相关的问题,请通过电子邮件 bwinkers@gmail.com 而不是使用问题跟踪器。
鸣谢
许可证
MIT 许可证 (MIT)。请参阅 许可证文件 了解更多信息。