@sstone1/repository-json-schema
v5.0.0
Published
Converts TS classes into JSON Schemas using TypeScript's reflection API
Downloads
1
Maintainers
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