Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ngduc/api-now
$ api-now - Launch an API Server to serve a JSON, JS file, GraphQL or faker data with HTTPS support.
https://github.com/ngduc/api-now
api https https-server json json-server mock mock-server server
Last synced: 2 days ago
JSON representation
$ api-now - Launch an API Server to serve a JSON, JS file, GraphQL or faker data with HTTPS support.
- Host: GitHub
- URL: https://github.com/ngduc/api-now
- Owner: ngduc
- License: mit
- Created: 2019-09-20T18:20:59.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-04-18T21:05:42.000Z (over 4 years ago)
- Last Synced: 2024-12-12T16:07:28.877Z (23 days ago)
- Topics: api, https, https-server, json, json-server, mock, mock-server, server
- Language: JavaScript
- Homepage:
- Size: 3.91 MB
- Stars: 111
- Watchers: 6
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🐕 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](tests/sample.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](tests/generateData.js)
## 📖 Command line options:
```
Usage: api-now [options] [json or js file]
Options:
-c, --cert HTTPS cert file
-k, --key HTTPS key file
-p, --port Use custom port
-s, --static 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](https://github.com/typicode/json-server)
- 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!)](https://medium.com/javascript-in-plain-english/fake-apis-for-your-ui-til-you-make-it-b6a2da89fdaa)
- Article: [How to create your command-line program (CLI) with NodeJS and Commander.js](https://medium.com/@ngduc/how-to-create-a-command-line-npm-module-cli-using-commander-js-1073e616aee7)
- One more thing:
- ★ this repo, open PRs and dance :)
## Development
All contributions are welcome!
- [Development](docs/development.md)