🐕 api-now

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

Based on json-server with more features:

• Default datasets out-of-the-box: todos, users, posts, comments (using faker). Just run $ api-now
• HTTPS support (with key, cert files).
• Can take a .json or .js file.
• GraphQL endpoint to serve faker data: /graphql
• Can serve a static directory (e.g. /dist, /public etc.)
• APIs support pagination (_page, _limit).
• /echo route to respond parameters back as json.
• /file route to serve any file type (including images).
• /login route (POST) to respond with a dummy JWT token (using jsonwebtoken).
• /todos route to return a list of todo items (follow TodoMVC specs).
• /image/random to serve a random image file from a directory.
• /avatar/random to serve a random avatar image.
• /nature/random to serve a random nature image.

🔧 Install

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

📖 Usage

$ api-now

That's it! You can try it now:

$ curl http://localhost:3003/todos
$ curl http://localhost:3003/users?_page=1&_limit=5    (others: /posts /comments)

Other Useful Routes:
$ curl http://localhost:3003/echo?any=value
$ curl http://localhost:3003/file?path=YourFilePath
$ curl http://localhost:3003/image/random?path=YourDirPath
$ curl http://localhost:3003/avatar/random
$ curl http://localhost:3003/nature/random
$ curl -X POST http://localhost:3003/login -H 'Content-Type: application/json' -d '{"username": "test"}'

Open GraphQL Query Page:
open http://localhost:3003/graphql

$ curl 'http://localhost:3003/graphql' -H 'Content-Type: application/json' --data-binary '{"query":"{ todos { title } }"}'

📖 Serve data from a file

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

{
  "posts": [
    { "id": 1, "title": "Post title 1" },
    { "id": 2, "title": "Post title 2" }
  ]
}

$ api-now db.json
$ api-now -k keyFile -c certFile -p 3003 -w db.json

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

📖 Command line options:

Usage: api-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
  -s, --static <dir>     Serve static directory (examples: ./dist, ./public)
  -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

• Article: Fake APIs for your UI ('til you make it!)

• Article: How to create your command-line program (CLI) with NodeJS and Commander.js

• One more thing:

  • ★ this repo, open PRs and dance :)

Development

All contributions are welcome!

• Development