Generated on Feb 15, 2024 via pnpm

Npm

Home

json-server 0.12.0

Serves JSON files through REST routes.

JSON

server

fake

Package summary

issues

licenses

Package created

3 Dec 2013

Version published

2 Aug 2017

Maintainers

Total deps

251

Direct deps

License

MIT

Issues

7 high severity issues

high

dot-prop@3.0.0

dot-prop Prototype Pollution vulnerability

Recommendation: Upgrade to version 4.2.1 or later

via: update-notifier@1.0.3

rc@1.2.8

Package uses a custom license expression: `(BSD-2-Clause OR MIT OR Apache-2.0)`

Recommendation: Validate that the license expression complies with your license policy

via: update-notifier@1.0.3

spdx-exceptions@2.5.0

Package uses an atypical license ("CC-BY-3.0")

Recommendation: Read and validate the license terms

via: yargs@6.6.0

har-validator@5.1.5

Deprecated package

via: request@2.88.2

request@2.88.2

Deprecated package

via: request@2.88.2

uuid@2.0.3

Deprecated package

via: update-notifier@1.0.3

uuid@3.4.0

Deprecated package

via: request@2.88.2

Collapse

Expand

4 moderate severity issues

moderate

yargs-parser@4.2.1

yargs-parser Vulnerable to Prototype Pollution

Recommendation: Upgrade to version 5.0.1 or later

via: yargs@6.6.0

got@5.7.1

Got allows a redirect to a UNIX socket

Recommendation: Upgrade to version 11.8.5 or later

via: update-notifier@1.0.3

request@2.88.2

Server-Side Request Forgery in Request

Recommendation: None

via: request@2.88.2

tough-cookie@2.5.0

tough-cookie Prototype Pollution vulnerability

Recommendation: Upgrade to version 4.1.3 or later

via: request@2.88.2

Collapse

Expand

2 low severity issues

low

spdx-exceptions@2.5.0

Package uses a license that is not OSI approved ("CC-BY-3.0")

Recommendation: Read and validate the license terms

via: yargs@6.6.0

spdx-license-ids@3.0.17

Package uses a license that is not OSI approved ("CC0-1.0")

Recommendation: Read and validate the license terms

via: yargs@6.6.0

Collapse

Expand

Licenses

MIT License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

sublicense

private-use

Cannot

hold-liable

Must

include-copyright

include-license

209 Packages, Including:

@types/keyv@3.1.4

@types/node@20.11.19

@types/responselike@1.0.3

accepts@1.3.8

ajv@6.12.6

ansi-regex@2.1.1

ansi-styles@2.2.1

array-flatten@1.1.1

asn1@0.2.6

assert-plus@1.0.0

asynckit@0.4.0

aws4@1.12.0

basic-auth@2.0.1

body-parser@1.20.1

body-parser@1.20.2

boxen@0.6.0

bytes@3.0.0

bytes@3.1.2

call-bind@1.0.7

camelcase@2.1.1

camelcase@3.0.0

capture-stack-trace@1.0.2

chalk@1.1.3

cli-boxes@1.0.0

code-point-at@1.1.0

combined-stream@1.0.8

compressible@2.0.18

compression@1.7.4

connect-pause@0.1.0

content-disposition@0.5.4

content-type@1.0.5

cookie-signature@1.0.6

cookie@0.5.0

core-util-is@1.0.2

core-util-is@1.0.3

cors@2.8.5

create-error-class@3.0.2

dashdash@1.14.1

debug@2.6.9

debug@4.3.4

decamelize@1.2.0

deep-extend@0.6.0

define-data-property@1.1.4

delayed-stream@1.0.0

depd@2.0.0

destroy@1.2.0

dot-prop@3.0.0

ecc-jsbn@0.1.2

ee-first@1.1.1

encodeurl@1.0.2

ISC License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

Cannot

hold-liable

Must

include-copyright

include-license

20 Packages, Including:

ansi-align@1.1.0

cliui@3.2.0

get-caller-file@1.0.3

graceful-fs@4.2.11

har-schema@2.0.0

hosted-git-info@2.8.9

inherits@2.0.4

ini@1.3.8

json-stringify-safe@5.0.1

osenv@0.1.5

require-main-filename@1.0.1

semver@5.7.2

server-destroy@1.0.1

set-blocking@2.0.0

setprototypeof@1.2.0

slide@1.1.6

which-module@1.0.0

write-file-atomic@1.3.4

y18n@3.2.2

yargs-parser@4.2.1

Apache License 2.0

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

sublicense

private-use

use-patent-claims

place-warranty

Cannot

hold-liable

use-trademark

Must

include-copyright

include-license

state-changes

include-notice

8 Packages, Including:

aws-sign2@0.7.0

caseless@0.12.0

forever-agent@0.6.1

oauth-sign@0.9.0

request@2.88.2

spdx-correct@3.2.0

tunnel-agent@0.6.0

validate-npm-package-license@3.0.4

BSD 3-Clause "New" or "Revised" License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

place-warranty

Cannot

use-trademark

hold-liable

Must

include-copyright

include-license

5 Packages, Including:

bcrypt-pbkdf@1.0.2

duplexer2@0.1.4

qs@6.11.0

qs@6.5.3

tough-cookie@2.5.0

BSD 2-Clause "Simplified" License

Permissive

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

modify

distribute

place-warranty

Cannot

hold-liable

Must

include-copyright

include-license

4 Packages, Including:

configstore@2.1.0

normalize-package-data@2.5.0

update-notifier@1.0.3

uri-js@4.4.1

(AFL-2.1 OR BSD-3-Clause)

Permissive

1 Packages, Including:

json-schema@0.4.0

(BSD-2-Clause OR MIT OR Apache-2.0)

Expression

1 Packages, Including:

rc@1.2.8

Creative Commons Attribution 3.0 Unported

Uncategorized

Not OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

Cannot

Must

1 Packages, Including:

spdx-exceptions@2.5.0

Creative Commons Zero v1.0 Universal

Public Domain

Not OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

Cannot

Must

1 Packages, Including:

spdx-license-ids@3.0.17

The Unlicense

Public Domain

OSI Approved

This is a human-readable summary of (and not a substitute for) the license. Disclaimer.

Can

commercial-use

private-use

modify

Cannot

include-copyright

hold-liable

Must

1 Packages, Including:

tweetnacl@0.14.5

Direct Dependencies

All Dependencies CSV

ⓘ This is a list of json-server 's direct dependencies. Data on all dependencies, including transitive ones, is available via CSV download.

Name	Version	Size	License	Type	Vulnerabilities
body-parser	1.20.2	14.75 kB	MIT	prod
chalk	1.1.3	5.11 kB	MIT	prod
compression	1.7.4	7.64 kB	MIT	prod
connect-pause	0.1.0	1.65 kB	MIT	prod
cors	2.8.5	6.03 kB	MIT	prod
errorhandler	1.5.1	5.75 kB	MIT	prod
express-urlrewrite	1.4.0	2.61 kB	MIT	prod
express	4.18.2	54.5 kB	MIT	prod
json-parse-helpfulerror	1.0.3	2.66 kB	MIT	prod
lodash-id	0.13.0	5.13 kB	MIT	prod
lodash	4.17.21	311.49 kB	MIT	prod
lowdb	0.15.5	9.45 kB	MIT	prod
method-override	2.3.10	5.65 kB	MIT	prod
morgan	1.10.0	9.37 kB	MIT	prod
object-assign	4.1.1	2.61 kB	MIT	prod
please-upgrade-node	3.2.0	2.73 kB	MIT	prod
pluralize	3.1.0	5.46 kB	MIT	prod
request	2.88.2	57.83 kB	Apache-2.0	prod	3 2
server-destroy	1.0.1	1.52 kB	ISC	prod
shortid	2.2.16	8.45 kB	MIT	prod
update-notifier	1.0.3	4.3 kB	BSD-2-Clause	prod	3 1
yargs	6.6.0	63.77 kB	MIT	prod	1 1 2

Tree

Treemap

Frequently Asked Questions

What does json-server do?

JSON Server is a versatile tool that creates a full fake REST API with zero coding, ideally in less than 30 seconds. It is ideal for front-end developers who need a quick back-end for prototyping and mocking. With its ability to generate an API that camouflages real server-side backed functionality, this tool streamlines the development process, saving time and energy.

How do you use json-server?

Using JSON Server is a straightforward task, given its user-friendly nature. Let's break it down:

Installation: Initiate the npm install command for json-server:
```
npm install -g json-server
```

Data setup: Create a db.json file with some data:

{
  "posts": [
    { "id": 1, "title": "json-server", "author": "typicode" }
  ],
  "comments": [
    { "id": 1, "body": "some comment", "postId": 1 }
  ],
  "profile": { "name": "typicode" }
}

Starting the JSON Server: Use the json-server command to start the server:
```
json-server --watch db.json
```

After following these steps, the JSON Server will be up and running, ready for data requests.

Where are the json-server docs?

The comprehensive documentation of JSON server is available in its GitHub repository: git://github.com/typicode/json-server.git. The repository readme includes an outline of getting started with basic installation instructions, followed by details on topics such as Routes, Extras, CLI usage, and Modules. Each topic is comprehensively covered with clear explanations and code snippets adding to the understanding of each feature and functionality provided by the JSON server. The repository also provides links to related video tutorials and articles, augmenting the understanding of the npm package from various other resources.