mock REST API
This repository holds a simple mock REST API that might be used for rapid SPA development. Especially, when there's no need to focus on the API itself - this one comes for free :)
early extended version
run the mock API:
npm run mock-api
run
install globally:
npm install -g mock-rest-api
and execute:
mock-rest-api
as simple as that
options
port
change the json-server port
mock-rest-api -p 3001
delay
set the delay for each request:
mock-rest-api -d 2500
file
instead of using default db.json, provide another database input file:
mock-rest-api -f alternative-db.json
(json-server will create an empty JSON db, if there's no file under a given path)
TypeScript .d.ts files
In the typedef/ directory you will find TypeScript definition files, which are automatically generated from JSON Schema. Use them in your TypeScript source.
develop
You can customize your mock-rest-api
fetch dependencies:
npm install
start REST API in your console:
npm start
npm start -- -p 3001
npm start -- -d 2500
npm start -- -f alternative-db.json
# override whatever params you wish
you should see something similar to this:
JSON Server is running
or this:
Loading db.json
Done
Resources
http://localhost:3000/config
http://localhost:3000/users
http://localhost:3000/todos
Home
http://localhost:3000
Re-generate TypeScript definition files:
npm run typedef
Important:
- the data is loaded from
db.jsonand stored in-memory by the OS process - upon process termination (ctrl-C), modified data is dumped back to
db.json - if you want to restart with clear data, use git to clear local changes (e.g.
git checkout db.json) before runningnpm startback
(re)generate data
Use this command:
npm run generate
to easily (re)generate entire database.
Additionally, you can add:
- new static files to
datadirectory - new JSON Schema files to
schemadirectory
You can also adapt generate.js file where you define size of the collection, filepaths, etc.