Swagger Faker

Swagger Faker

Swagger Faker は、swagger.json ファイルからフェイクデータを生成し、生成したフェイクデータを使ってモックサーバーを自動的に起動するツールです。

使い方

1. インストール

npm i swagger-faker -g

2. 次のコマンドで設定ファイルを初期化します。

swagger-faker init

すると、現在のパスに設定ファイル swagger-faker.config.json が生成されます。その設定ファイルを更新します。

{
  "sourcePaths": ["./source/openapi.json"],
  "outputFolder": "mock-server",
  "timeout": 180000,
  "port": 8081
}

• sourcePaths: 必須。swagger/openapi ファイルのパスを指定します
• outputFolder: 任意
• timeout: 任意
• port: 任意

3. フェイクデータを生成します

swagger-faker gen

4. モックサーバーを起動します

swagger-faker run

使用例

git clone https://github.com/reeli/swagger-faker-examples.git
cd  swagger-faker-examples
npm install
npm start

すると、次のようになります。

1. 現在のパスに mock-server フォルダーが生成され、すべてのモックデータが mock-server/data フォルダーに設定されます。必要に応じてカスタマイズできます。
2. モックサーバーが http://localhost:8081 で起動します。ブラウザーを開き、http://localhost:8081/api/v2/store/order/1 でモック API のいずれかにアクセスできます（モックデータは mock-server/data/getOrderById.json に設定されています）。