Skip to content

Latest commit

 

History

History
37 lines (30 loc) · 726 Bytes

README.md

File metadata and controls

37 lines (30 loc) · 726 Bytes

Faker plugin

A plugin to generate fake data.

Install

Add it to your norest.config.js file:

const FakerModule = require('@norest/plugin-faker').FakerModule;

module.exports = {
  plugins: [FakerModule.register()]
};

Usage

POST a FakeDefinition to the /faker/fake endpoint:

POST http://localhost:3030/faker/fake
{
	"collection": "nr-fake-test",
  "namespace": "hacker",
  "amount": 20
}

To add more fake data, PUT to /faker/fake endpoint:

PUT http://localhost:3030/faker/fake
{
	"collection": "nr-fake-test",
  "namespace": "animal",
  "amount": 10
}

As namespaces can be used any of the faker.js API methods.