Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Objectway/json-rest-server

Open more actions menu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
46 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

json-rest-server

A simple json REST server that exposes all json files contained in a directory tree.

Install

npm install -g json-rest-server

Example

Create a directory tree with sub directories and valid .json files like this:

myapi
├── blog/
│   ├── posts/
│   │	├── 1.json
│   │   ├── 1
│   │   │   ├── comments/
│   │   │   │   ├── 1.json
│   │   ├── 2.json
│   │   ├── 3.json
├── app/
│   ├── users.json

Start your server

$ json-rest-server myapi -P 3000 -C

Now if you go to http://localhost:3000/blog/posts/1, you'll get the content of 1.json inside posts

But if you go to http://localhost:3000/blog/posts/1/comments, you'll get an array with the content of all json files that are in the comments folder

Options

--port (-P)

Set a different port to the default 3000

$ json-rest-server myapi -P 3001

--allowCORS (-C)

Enable cross-origin resource sharing (CORS), default is disabled

$ json-rest-server myapi -C

Routes

Like REST, you can have GET and POST on folders and GET, PUT and DELETE on json files. Based on previous example, you can have

GET    /blog/posts				-> ARRAY of json files conteined in myapi/blog/posts
GET    /blog/posts/1			-> JSON content of myapi/blog/posts/1.json
GET    /blog/posts/1/comments	-> ARRAY of json files conteined in myapi/blog/posts/1/comments
POST   /blog/posts				-> CREATE a new json file in myapi/blog/posts
PUT    /blog/posts/1			-> UPDATE content of myapi/blog/posts/1.json
PATCH  /blog/posts/1			-> UPDATE content of myapi/blog/posts/1.json merging with existing content
DELETE /blog/posts/1			-> DELETE file myapi/blog/posts/1.json

Extras

It's an alternative to npm json-server

About

A simple json REST server that exposes all json files contained in a directory tree

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  
Morty Proxy This is a proxified and sanitized view of the page, visit original site.