h1025 / cvoutput
v1.1.1
2021-07-01 04:43 UTC
Requires
- php: >= 7.4.0
- ext-json: *
- ext-yaml: *
- mihoshi/hashvalidator: 1.*
Requires (Dev)
README
- 使用hash validator中的验证规则来生成具有相同数据结构的C#类的代码。
- 由于需要明确namespace、类名、extend等特定值,因此通过扩展hashRule规则来实现。
~目录~
限制事项
主要目的是规定Unity中执行HTTP通信时的接口,因此包含相应的约束
支持的格式
hash validator曾支持PHP中的关联数组、json文件、yaml文件,但本工具仅支持yaml
用法
# ./cvoutput [type] [inputDir] [outputDir]
类型列表
C# 文件创建
关于Yaml文件格式的说明
[文件名]
inputPath指定目录 指定目录以下、符合文件名规则的文件都将作为目标
[文件名规则]
Request(Response).yml
[示例]
使用inputPath指定的目录下一级路径(包括文件名)作为API名称
- 文件结构
.
└── hoge_dir
└── fuga_dir
└── hoge
└── fuga
├── Request.yml
└── Response.yml
- inputPath
./hoge_dir/fuga_dir
-
类名
-
hogefugaRequest
-
hogefugaResponse
-
-
API名称
hoge/fuga
API规范书 创建
输出
- 在outputPath目录下生成包含API名称、URL、key等的README.md列表。