Light

putan / stubon Goto Github PK

View Code? Open in Web Editor NEW

8.0 1.0 1.0 396 KB

stubon is simple dummy api server.

License: MIT License

JavaScript 100.00%

stub-api dummy-api

stubon's Introduction

Stubon

stubon is simple dummy api server.

0. install

$ npm i -D stubon

1. Make source file by JSON or YAML or both.

When "http request" includes all condition that written under "request", value returned that under correspond "response.body". Sample is here.

// ./dev/src/dummy.yml
'/aaa/get':
    -
        request:
            method: 'GET'
        response:
            status: 200
            body:
                result: 'OK!'

2. Create server.

2.1 The way to make with a file.

var Stubon = require('stubon').default; // = import Stubon from 'stubon';

var srcPath = './dev/src';
var stubon = new Stubon(srcPath, {
    debug : true,
    ssl   : true,
});

stubon.server().listen(8080);

2.2 The way to make with a command line.

$ $(npm bin)/stubon -p 8080 -s ./dev/src --debug --ssl

3. Call a dummy API.

$ open https://localhost:8080/aaa/get

If you call API from node script, you need setting option 'agent'.
When you call from browser, you can do permission setting on the browser side.

// call_api.js
fetch('https://localhost:8080/aaa/get', {
    agent : new https.Agent({ rejectUnauthorized : false }),
})
    .then(function(res) {
        return res.json();
    })
    .then(function(json) {
        console.log(json.result); // OK!
    });

$ node call_api.js

stubon's People

Contributors

Stargazers

Watchers

Forkers

shibe97

stubon's Issues

js setting files

I want to be able to use the setting file written in javascript

e.g.

const message = 'hoge';

export default {
    '/hoge' : [
        request: {
            method: 'GET',
        },
        response: {
            status: 200,
            body: {
                result: [
                    { id: 1, msg: message }, // can use variables.
                    { id: 2, msg: message },
                ],
            },
        },
    ],
};

I want to be able to designate an arbitrary value for the request key

e.g.

If the value is '*' in the string, check only the existence of the key and make it a match.

'/aaa/get/{id}':
    -
        request:
            method: 'GET'
            params:
                id: '*'   <- match any id, but if there is no "id", it will be mismatch.
        response:
            status: 200
            body:
                result: 'OK! aaa!'

Request header field ... is not allowed by Access-Control-Allow-Headers in preflight response.

res.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept, *');

を追加する。

cannot set less than 1sec to options.lagSec

https://github.com/putan/stubon/blob/master/src/stubon.js#L325

change parseInt to parseFloat.

Implement the difference check properly

Now I cut corners using "deep-diff".
I will implement it myself, because I can not do fine-tuning.

ssl証明書のパスが切れている

__dirnameで上手く繋ぐ。

CORSの場合にメソッドが全部OPTIONSになってしまってマッチしない

OPTIONSの場合は、access-control-request-method に元のメソッドがあるのでそれに置き換えてチェックする

hot reload

I want to monitor the setting file and reflect it immediately when there is a change.

Accept enum

e.g.

'/aaa/get':
    -
        request:
            method: 'GET'
            queries:
                type: '{TYPE_A|TYPE_B}'   <- match 'TYPE_A' or 'TYPE_B'
        response:
            status: 200
            body:
                result: 'OK! aaa!'

Clean up the debug log

Difficult to understand

Recommend Projects

React

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

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

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

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
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.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

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

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.