json-now

0.1.5 • Public • Published

🐕 json-now

Launch an API Server to serve data from a JSON, JS file or faker data with HTTPS support.

Based on json-server. More features:

  • Default datasets out-of-the-box: users, posts (using faker). Just run $ json-now
  • HTTPS support (with key, cert files).
  • Can take .json or .js file.

🔧 INSTALL

  • As a dependency: $ npm install json-now
  • As a global command: $ npm install json-now -g
  • Or run it without installing: $ npx json-now

📖 USAGE

$ json-now

Then try it like $ curl http://localhost:3003/users

Serve data from a JSON file:

Create db.json file, then run json-now to start a HTTPS server at port 3003:

{
  "posts": [
    { "id": 1, "title": "Post title 1" },
    { "id": 2, "title": "Post title 2" }
  ]
}
$ json-now db.json
$ json-now -k keyFile -c certFile -p 3003 -w db.json

Or create a .js file and use "faker" data like generateData.js

How to use:

Usage: json-now [options] [json or js file]
Options:
  -c, --cert <certFile>  HTTPS cert file
  -k, --key <keyFile>    HTTPS key file
  -p, --port <port>      Use custom port
  -v, --version          Show version
  -w, --watch            Watch for changes and reload (default: false)
  -h, --help             Output usage information

📖 TIPS

  • json-server - Repo & Documents

  • Command line to generate self-signed Key & Cert files:

openssl req -new -newkey rsa:4096 -days 3650 -nodes -x509 -subj "/C=US/ST=California/L=San Francisco/O=Organization/CN=CommonName" -keyout key.pem -out cert.pem

Dependencies (3)

Dev Dependencies (5)

Package Sidebar

Install

npm i json-now

Weekly Downloads

0

Version

0.1.5

License

MIT

Unpacked Size

244 kB

Total Files

18

Last publish

Collaborators

  • ngduc