npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

json-mock-api

v1.2.2

Published

Mock an api with plain json files

Downloads

1,200

Readme

Json Mock Api npm version

Mock an api with plain json files. This simple CLI tool allows you to turn a folder of static json files into a mock api server.


Table of Contents:

Usage

Without installing (using npx , shipped with [email protected] and higher)

npx json-mock-api --port 3000 --directory .

or

Add json-mock-api to your project ...

npm install --save json-mock-api

... then update your package.json ...

{
    "scripts": {
+       "mock": "json-mock-api --port 3000 --directory ."
    }
}

... and finally run the command

npm run mock

Options

Usage: json-mock-api [options]

Options:

  -v, --version             output the version number
  -c, --cors                Enable CORS on al requests
  -d, --directory [path]    Directory (default: .)
  -m, --middleware <files>  Expressjs middleware (default: )
  -p, --port [number]       Port (default: 3000)
  -h, --help                output usage information

Examples:

  $ json-mock-api --middleware ./middleware-1.js,./middleware-2.js

The Json files

Given this file structure:

.
└── api/
    ├── login.json
    ├── product/
    │   └── index.json
    ├── user/
    │   └── 1.json
    └── users.json

That results in the following endpoints:

http://localhost:3000/api/login
http://localhost:3000/api/products
http://localhost:3000/api/user/1
http://localhost:3000/api/users

Handling different HTTP Verbs

You can specify a HTTP Verb in the json file name like so:

.
└── api/
    └── user/
        ├── 1.json
        ├── 1.post.json
        └── 1.put.json

When you access the endpoint http://localhost:3000/api/user/1 via:

  • a POST request, the file ./api/user/1.post.json is returned
  • a PUT request, the file ./api/user/1.put.json is returned
  • any other verb (GET, DELETE, ...), the file ./api/user/1.json is returned

Custom middleware

You can run your own ExpressJS middleware if you want to.

To load your own middleware, use the -m or --middleware flags:

json-mock-api --middlware ./middlware-1.js,./middleware-2.js

The above command will load the files middleware-1.js and middleware-2.js from the current working directory and use them in this order when a request is made before the response is send to the user.

You could use your own middleware to, for example, add authentication.

Author

Peter Goes (@petergoes) - petergoes.nl

License

MIT