Giter Club home page Giter Club logo

fakeit's Introduction

Fakeit

CircleCI Code Climate maintainability Gem Gem Docker Pulls GitHub

Create mock server from Openapi specification

Features

  • 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

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 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 for Openapi properties supported in random response generation
  • See here 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.

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.