opensource/json-server
1
0
Fork 0
mirror of https://github.com/typicode/json-server.git synced 2025-07-28 12:43:18 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Typicode
2015-05-07 15:11:15 +02:00
parent 73f919ddd0
commit 698bf6b025
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,4 +1,4 @@
# JSON Server [![](https://travis-ci.org/typicode/json-server.svg)](https://travis-ci.org/typicode/json-server) [![](https://badge.fury.io/js/json-server.svg)](http://badge.fury.io/js/json-server) [![Join the chat at https://gitter.im/typicode/json-server](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/typicode/json-server?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) # JSON Server [![](https://travis-ci.org/typicode/json-server.svg)](https://travis-ci.org/typicode/json-server) [![](https://badge.fury.io/js/json-server.svg)](http://badge.fury.io/js/json-server)
> Get a full fake REST API with __zero coding__ in __less than 30 seconds__ (seriously) > Get a full fake REST API with __zero coding__ in __less than 30 seconds__ (seriously)
@ -33,11 +33,11 @@ Now if you go to [http://localhost:3000/posts/1](), you'll get
{ "id": 1, "title": "json-server", "author": "typicode" } { "id": 1, "title": "json-server", "author": "typicode" }
``` ```
Also, if you make POST, PUT, PATCH or DELETE requests, changes will be automatically saved to `db.json` using [lowdb](https://github.com/typicode/lowdb) Also, if you make POST, PUT, PATCH or DELETE requests, changes will be saved to `db.json`
## Routes ## Routes
Here are all the available routes. Based on the previous `db.json`, here are all the available routes.
``` ```
GET /posts GET /posts
@ -113,11 +113,11 @@ $ json-server http://jsonplaceholder.typicode.com/db
You can use JS to programmatically create data: You can use JS to programmatically create data:
```javascript ```javascript
module.exports = function () { module.exports = function() {
data = { users: [] } data = { users: [] }
// Create 1000 users // Create 1000 users
for (var i = 0; i < 1000; i++) { for (var i = 0; i < 1000; i++) {
data.users.push({ id: i, name: 'user' + i }) data.users.push({ name: 'user' + i })
} }
return data return data
} }
@ -149,13 +149,13 @@ You can deploy JSON Server. For example, [JSONPlaceholder](http://jsonplaceholde
## Links ## Links
### Video tutorial ### Video
* [Creating Demo APIs with json-server on egghead.io](https://egghead.io/lessons/nodejs-creating-demo-apis-with-json-server) * [Creating Demo APIs with json-server on egghead.io](https://egghead.io/lessons/nodejs-creating-demo-apis-with-json-server)
### Articles ### Articles
* [Fast prototyping using Restangular and Json-server](http://glebbahmutov.com/blog/fast-prototyping-using-restangular-and-json-server/) * [Fast prototyping using Restangular and Json-server](http://glebbahmutov.com/blog/fast-prototyping-restangular-and-json-server/)
* [ng-admin: Add an AngularJS admin GUI to any RESTful API](http://marmelab.com/blog/2014/09/15/easy-backend-for-your-restful-api.html) * [ng-admin: Add an AngularJS admin GUI to any RESTful API](http://marmelab.com/blog/2014/09/15/easy-backend-for-your-restful-api.html)
* [how to build quick json REST APIs for development](http://outloudthinking.me/how-to-build-quick-json-rest-apis/) * [how to build quick json REST APIs for development](http://outloudthinking.me/how-to-build-quick-json-rest-apis/)