README.md in fakeit-0.1.5 vs README.md in fakeit-0.2.0

- old
+ new

@@ -7,13 +7,13 @@ [![Docker Pulls](https://img.shields.io/docker/pulls/realfengjia/fakeit.svg)](https://hub.docker.com/r/realfengjia/fakeit) [![GitHub](https://img.shields.io/github/license/JustinFeng/fakeit.svg)](https://opensource.org/licenses/MIT) Create mock server from Openapi specification -## Description +## Features -* Randomly generated response +* Randomly or statically generated response * Request validation * Load specification from local or remote * Support specification in yaml or json format **Note:** Only support json content type as of now @@ -35,17 +35,23 @@ $ fakeit --help usage: --spec spec file uri (required) -p, --port custom port -q, --quiet mute request and response log - --permissive log validation error as warning instead of deny request - --use-example use example provided in spec + --permissive log validation error as warning instead of denying request + --use-example use example provided in spec if exists + trial options: + --static generate static response + other options: -v, --version -h, --help **Notes:** +* See [here](docs/random.md) for Openapi properties supported in random response generation +* See [here](docs/static.md) for default value in static response generation +* Regarding `--use-example` mode, property without example specified will still be randomly or statically generated * Random response generation can not handle recursive schema reference. If you do need it in your spec file, please provide `example` property for the recursive part of schema and specify `--use-example` option. ## Development After checking out the repo, run `bundle install` to install dependencies. Then, run `rake` to run the tests.