Skip to content
Create mock server from Openapi specification
Branch: master
Clone or download
Latest commit 73cd51d Jun 16, 2019

README.md

Fakeit

CircleCI Code Climate maintainability Gem Gem Docker Pulls GitHub

Create mock server from Openapi specification

Description

  • Randomly 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

Installation

Install it with:

$ gem install fakeit

Or use the docker image

Usage

$ fakeit --spec <Local file or remote url>

Command line options:

$ 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

other options:
    -v, --version
    -h, --help

Development

After checking out the repo, run bundle install to install dependencies. Then, run rake to run the tests.

To install this gem onto your local machine, run bundle exec rake install.

To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/JustinFeng/fakeit.

License

The gem is available as open source under the terms of the MIT License.

You can’t perform that action at this time.