Skip to content
JSON-Schema + fake data generators
JavaScript
Branch: master
Clone or download
Latest commit 6c728d0 Oct 30, 2019

README.md

JSON Schema Faker logo

Donate Build Status NPM version Bower version Coverage Status

Gitter Dependency Status devDependency Status

Inline docs Typedoc Known Vulnerabilities

Use JSON Schema along with fake generators to provide consistent and meaningful fake data for your system.

What's next?

On RC17 support for more keywords landed, but is still outdated from recent JSON-Schema drafts.

  • Many bugs were gone and no new features were introduced this time, documentation is still incomplete.
  • Support for not keywords are still missing or partially working, please read the docs to see all supported keywords.

Since RC16 comes with some deprecations and breaking-changes towards v0.5.x API:

  • deprecated — You will not longer be able to call jsf() and get a fully-dereferenced result. It will just generate given refs and inline ones, nothing else.
    • jsf.generate() is the sync-version, with partial dereferencing through given refs, etc.
    • jsf.resolve() is the async-version, with full dereferencing, given refs are also supported.
  • deprecated — TypeScript sources are not longer used, however d.ts definitions will be updated on time.

Usage info from README.md was moved to docs/, read more.

Contributors

We are more than happy to welcome new contributors, our project is still being developed, but we need more feedback!

Please see our contribution guide to learn how.

We are looking for your help!

We have a gitter room for this project, if you want to contribute, talk about specific issues from the library, or you need help on json-schema topics just reach out to us!

Please take a look at the technical documentation page.

If you think json-schema-faker is adding value on what you're doing please consider buying me a coffee.

Also, you can support the project via Open Collective.

You can’t perform that action at this time.