opensource/json-server
1
0
Fork 0
mirror of https://github.com/typicode/json-server.git synced 2025-08-02 11:32:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md, fixing examples with bad JSON

Browse Source 
The examples given in the README do not conform to the JSON specification. In fact, when run in the way shown, it doesn't even work. 

This commit fixes the formatting issues in the JSONs. They are mostly wrapping attribute names in quotes, and changing single quotes to double quotes.

I also made those changed to JS objects that wasn't specifically JSON, but would be nice to be formatted like JSON in case someone wants to copy the example and paste it into a .json file.
This commit is contained in:
Guilherme Berger
2013-12-26 19:02:21 -02:00
parent bc36ab093e
commit 4f9f1fa9c8
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -16,8 +16,8 @@ Created with :heart: for front-end developers who need a flexible back-end for q
```bash
$ cat db.json
{
posts: [
{ id: 1, body: 'foo' }
"posts": [
{ "id": 1, "body": "foo" }
]
}
$ json-server --file db.json
@ -29,9 +29,9 @@ $ curl -i http://localhost:3000/posts/1
```javascript
var server = require('json-server');
var db = {
posts: [
{id: 1, body: 'foo'}
var db = {
"posts": [
{ "id": 1, "body": "foo" }
]
}
@ -97,13 +97,13 @@ Here's 2 examples showing how to format JSON or JS seed file:
```javascript
{
posts: [
{ id: 1, body: 'foo'},
{ id: 2, body: 'bar'}
"posts": [
{ "id": 1, "body": "foo"},
{ "id": 2, "body": "bar"}
],
comments: [
{ id: 1, body: 'baz', postId: 1}
{ id: 2, body: 'qux', postId: 2}
"comments": [
{ "id": 1, "body": "baz", "postId": 1}
{ "id": 2, "body": "qux", "postId": 2}
]
}
```
@ -115,7 +115,7 @@ exports.run = function() {
var data = {};
data.posts = [];
data.posts.push({id: 1, body: 'foo'});
data.posts.push({"id": 1, "body": "foo"});
//...
return data;