Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
a simple zero-configuration restful service mockup tool
JavaScript
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
sample_server
server
.travis.yml
README.md
package.json

README.md

alt tag

kakuen

Build Status

Write by homerquan

What's kakun

Mock up RESTful webservices simply by editing text files, e.g.,

  1. GET__#book#123#authors.json ==> GET /book/123/authors
  2. POST__#book@id=123.json ==> POST /book?id=123
  3. [NEW FEATURE] GET__#book@id={param}.json ==> GET /book?id=123

For json, a schema-based mockup is supported, e.g., in sample_server/mocks/GET__#search@q=js.json

  • for single item
    
        "@KAKUEN_ITEM(offset)": {
            "@KAKUEN_TYPE": "natural",
            "@KAKUEN_PARAM": {
                "min": 1,
                "max": 20
            }
        }
    
    will be offset:12
  • for collection
    
       "@KAKUEN_COLLECTION(data)(10)": {
        "name": {
            "@KAKUEN_TYPE": "name",
            "@KAKUEN_PARAM": {
                "middle_initial": true
            }
        },
        "cover-image": {
            "@KAKUEN_TYPE": "image",
            "@KAKUEN_PARAM": {
                "w": 165,
                "h": 165,
                "topic": "sports"
            }
        }
    }
    
    will be
    
    [
     {
      name: "Leo B. McCarthy",
      cover-image: "http://lorempixel.com/165/165/sports"
     },
     ... and 9 more
    ]
    

Quick start

  1. Install

    $ npm install kakuen

  2. Launch the sample server or create your own by using kakuen as a handler in express e.g., server.js

    
    var express=require('express'),
    kakuen=require('kakuen'),
    server=express(),
    moker=kakuen.mocker;

    server.use(moker); server.listen(8005);

  3. Put mockup files in "mocks" at the root directory of your node app (or specify it: export KAKUEN_MOCKS_FOLDER="your_mocks_folder" ). Then adding or editing your own json or xml files under 'mocks' in the format:<method>__#url.[xml|json] e.g., GET__#book@id=123.json ('#' to replace '/', '@' to replace '?') E.g.,
    • DELETE__#book@id=123.json (DELETE /book?id=123
    • GET__#book@id=1234&type=0.xml (GET /book?id=1234&type=0)
  4. Finally Start the server and access mocks E.g.,
    • curl http://localhost:8005/book?id=123
    • curl http://localhost:8005/search?q=java
    • curl http://localhost:8005/search?q=js

Generating mockup data by type

  • all data types in the document of chance.js, such as person name, address, ipv6 ... e.g., chance.month({raw: true}); will be

    
       "@KAKUEN_TYPE": "month",
       "@KAKUEN_PARAM": {
       "raw": true,
       }
    

  • image from lorempixel.com, which needs to specify weight, height, and topic (option) e.g.,

    
    "cover-image": {
    "@KAKUEN_TYPE": "image",
    "@KAKUEN_PARAM": {
        "w": 165,
        "h": 165,
        "topic": "sports"
    }
    }
    

Features

  • actively monitoring change in mock files.
  • support both json and xml
  • support scheme (for json only)
  • support random typed data generator (for json only)

Change log

  • v4.0.0 add schema-based mockup using chance data generator
  • v3.5.4 fix file name in windows system

Roadmap

Author

  • Homer Quan

License

The MIT license.

Copyright (c) 2013 Homer Quan (http://www.homerquan.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.