hskrasek / openapi-schema-to-json-schema
PHP 库,用于将 OpenAPI 架构对象转换为 JSON Schema
0.2.0
2018-02-07 19:03 UTC
Requires
- php: >=7.1
- league/flysystem: ^1.0
- league/json-reference: dev-master
- league/pipeline: ^0.3.0
- symfony/console: ~3.3 | ^4.0
- symfony/property-access: ^4.0
- symfony/property-info: ^4.0
- symfony/serializer: ^4.0
- symfony/yaml: ^4.0
Requires (Dev)
- phpunit/phpunit: ^6.5
- squizlabs/php_codesniffer: ^2.3
This package is auto-updated.
Last update: 2024-09-25 00:24:40 UTC
README
这是与Node 包同名的 PHP 版本,所以向在 GitHub 用户 mikunn 表示敬意,感谢他的工作。此包目前支持从 OpenAPI 3.0 转换到 JSON Schema Draft 4。
特性
- 将 OpenAPI 3.0 架构对象转换为 JSON Schema Draft 4
- 将常见命名数据类型转换为
type
和format
- 例如,
type: "dateTime"
转换为type: "string"
并带有format: "date-time"
- 例如,
- 如果
nullable
为true
,则删除nullable
并在type
数组中添加"null"
- 支持具有嵌套
allOf
等的深度结构 - 删除 OpenAPI 特定属性,例如
discriminator
、deprecated
等,除非指定其他属性 - 可选支持 Schema 对象中的
patternProperties
和x-patternProperties
注意:$ref
不会被解析。在使用此包之前,请使用像 json-schema-ref-parser 这样的解析器。
安装
通过 Composer
$ composer require hskrasek/openapi-schema-to-json-schema
用法
vendor/bin/oas-to-jsonschema convert docs/schemas docs/specs
变更日志
有关最近更改的更多信息,请参阅CHANGELOG。
测试
$ composer test
贡献
有关详细信息,请参阅CONTRIBUTING 和 CODE_OF_CONDUCT。
安全
如果您发现任何安全相关的问题,请通过电子邮件 hunterskrasek@me.com 而不是使用问题跟踪器。
鸣谢
许可协议
MIT 许可协议 (MIT)。有关更多信息,请参阅许可文件。