Skip to content

Installation

Install the package in your app with:

bash
npm install json-rest-schema

If you are working in this repo and want to run the documentation site locally:

bash
npm install
npm run docs:dev

Build the full static site, including the standalone React and Vue demo apps, with:

bash
npm run docs:build

Preview that built site locally with:

bash
npm run docs:preview

The published docs site is the best place to read the same manual as shorter chapters for:

  • create / replace / patch semantics
  • nested object and array contracts
  • recursive runtime validation and transport export
  • field introspection and path-scoped validation
  • React Hook Form, Vue + Vuetify, and VeeValidate adapters
  • demo app walkthroughs

GPL-3.0-only