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)

• phpunit/phpunit: *

MIT

README

• hash validator でのバリデーションルールをもとに同等のデータ構造を持つクラスのC#コードを生成させる。
• namespaceやクラス名,extendなど固有の値を明示することになるため、hashRuleを拡張したルールを使用することで実現している。

～目次～

制限事項

対応フォーマット

使い方

C# ファイル作成

• Yamlファイルの記法に関して

API仕様書 作成

制限事項

UnityでHTTP通信を行う際のインターフェースを規定することを主目的としており、これに準じた制約が含まれている

対応フォーマット

hash validatorはPHPでの連想配列,jsonファイル,yamlファイルに対応していたが、本ツールではyamlのみ対応する

使い方

# ./cvoutput [type] [inputDir] [outputDir]

type一覧

• csharp
  • C# ファイル作成
• md
  • API仕様書 作成

C# ファイル作成

Yamlファイルの記法に関して

[ファイル名]

inputPathはディレクトリ指定 指定したディレクトリ以下の、ファイル名規則に沿ったファイル全てを対象とする

[ファイル名規則]

Request(Response).yml

[例]

inputPathで指定したディレクトリの1つ下のパスから、ファイル名を含めないファイルのパスまでを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として出力されます。