@loopback/repository-json-schema

Converts TS classes into JSON Schemas using TypeScript's reflection API

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
3,673472Jun 11, 2021Jan 9, 2017Minified + gzip package size for @loopback/repository-json-schema in KB

Readme

@loopback/repository-json-schema

Convert a TypeScript class/model to a JSON Schema for users, leveraging LoopBack4's decorators, metadata, and reflection system.

Overview

This package provides modules to easily convert LoopBack4 models that have been decorated with @model and @property to a matching JSON Schema Definition.

Installation

$ npm install --save @loopback/repository-json-schema

Basic use

import {getJsonSchema} from '@loopback/repository-json-schema';
import {model, property} from '@loopback/repository';

@model()
class MyModel {
  @property()
  name: string;
}

const jsonSchema = getJsonSchema(MyModel);

The value of jsonSchema will be:

{
  "title": "MyModel",
  "properties": {
    "name": {
      "type": "string"
    }
  }
}

Contributions

Tests

Run npm test from the root folder.

Contributors

See all contributors.

License

MIT

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.