calcinai/gendarme

基于 JSON 架构生成约束 SKDs 的应用程序

维护者

详细信息

github.com/calcinai/gendarme

源代码

问题

安装: 13

依赖项: 0

建议者: 0

安全: 0

星级: 3

关注者: 2

分支: 1

开放问题: 1

v0.1.2 2016-12-01 16:00 UTC

Requires

MIT 7b8e622d071eb46f0e51efe81b610b0d407c2e7f

This package is auto-updated.

Last update: 2024-09-14 22:00:28 UTC

README

一个从 JSON Schemas 创建 PHP 数据结构的工具。

设置

通过 composer

composer create-project calcinai/gendarme

用法

从项目根目录

./bin/gendarme generate --namespace [TARGET_NAMESPACE] --root-class [ROOT_CLASS]  [SCHEMA_FILE].json [OUTPUT_DIR]

输出

所有模型将基于运行时提供的参数遵循 PSR-4 规范。典型的输出文件夹结构如下所示

- OUTPUT_DIR
  - BaseSchema.php (the class all models extend)
  - RootClass.php (the --root-class argument)
  - Definitions
    - ...
    - ...

本项目旨在为 Strut（一个 Swagger/OAPI 操作库）生成架构文件。虽然这是一个非常复杂的示例，但它展示了将要生成的基本输出结构。

生成的模型将尽可能包含对其他模型的类型提示，而不可提示的对象将被放入文档块中。到目前为止，许多但并非所有架构关键字都已被解析。随着更多所需功能的确定，可以实施更多功能。