https://github.com/nejdetkadir/json-server-clone
Create a server and serve content of your json files in localhost
https://github.com/nejdetkadir/json-server-clone
json-api json-server rest-api restful-api
Last synced: over 1 year ago
JSON representation
Create a server and serve content of your json files in localhost
- Host: GitHub
- URL: https://github.com/nejdetkadir/json-server-clone
- Owner: nejdetkadir
- License: mit
- Created: 2021-01-30T03:42:58.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-30T19:03:58.000Z (over 5 years ago)
- Last Synced: 2025-01-23T19:38:44.345Z (over 1 year ago)
- Topics: json-api, json-server, rest-api, restful-api
- Language: JavaScript
- Homepage:
- Size: 118 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JSON SERVER
Create a server and serve content of your json files in localhost
# Usage
You can use this command for just serve files with your specific port. You can use without port with this command. Port will be default defined as 5555
```sh
$ node index.js --port=
```
Output:
```sh
[
{ file: '', url: 'http://localhost:/' },
port: ,
base_url: 'http://localhost:',
server_status: 'online'
]
```
If you want to create REST API with zero coding, you can use watch command. Watch command supports only one file but supports specific port
```sh
$ node index.js --watch --port=
```
Output:
```sh
[
{
description: 'List all as JSON',
url: 'http://localhost:/'
},
{
description: 'Get single with id as JSON',
url: 'http://localhost://:id'
},
data_table: '',
port: ,
base_url: 'http://localhost:',
server_status: 'online'
]
```
# Examples
You can use without port with this command
```sh
$ node index.js api/data.json
```
Output:
```sh
[
{ file: 'data.json', url: 'http://localhost:5555/data' },
port: 5555,
base_url: 'http://localhost:5555',
server_status: 'online'
]
```
You can serve multiple JSON files with this command
```sh
$ node index.js api/foo.json api/bar.json
```
Output:
```sh
[
{ file: 'foo.json', url: 'http://localhost:5555/foo' },
{ file: 'bar.json', url: 'http://localhost:5555/bar' },
port: 5555,
base_url: 'http://localhost:5555',
server_status: 'online'
]
```
You can serve JSON file like REST API with watch command.
```sh
$ node index.js --watch api/foo.json
```
Output:
```sh
[
{
description: 'List all posts as JSON',
url: 'http://localhost:5555/posts'
},
{
description: 'Get single post with id as JSON',
url: 'http://localhost:5555/posts/:id'
},
data_table: 'posts',
port: 5555,
base_url: 'http://localhost:5555',
server_status: 'online'
]
```
# LICENSE
```
MIT License
Copyright (c) 2021 Nejdet Kadir Bektaş
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```