Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/giovannicardamone/class-schema
Javascript / Typescript class to JsonSchema
https://github.com/giovannicardamone/class-schema
browser json-schema nodejs typescript
Last synced: about 2 months ago
JSON representation
Javascript / Typescript class to JsonSchema
- Host: GitHub
- URL: https://github.com/giovannicardamone/class-schema
- Owner: GiovanniCardamone
- License: mit
- Created: 2021-08-01T10:50:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-21T16:04:38.000Z (almost 2 years ago)
- Last Synced: 2024-08-10T23:44:09.475Z (5 months ago)
- Topics: browser, json-schema, nodejs, typescript
- Language: TypeScript
- Homepage: https://giovannicardam.one/class-schema
- Size: 353 KB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# class-schema
 
[](https://github.com/GiovanniCardamone/class-schema/actions/workflows/npm-ci.yml)
[](https://coveralls.io/github/GiovanniCardamone/class-schema?branch=main)
[](https://snyk.io/test/github/GiovanniCardamone/class-schema)
[](https://www.npmjs.com/package/class-schema)
[](https://www.npmjs.com/package/class-schema)
class-schema is a library intended to extract from javascript class, the corrispondent [JSON Schema](https://json-schema.org/), usually, the schema is written by hand or throught some tool that create the schema.
but, with this library you can extract the schema directly from the class you defined, so you have a single source of truth of the schema [SSOT](https://en.wikipedia.org/wiki/Single_source_of_truth) that is your class.
## :package: Installation
```bash
npm install class-schema
```
to use `class-schema` you also need the package `reflect-metadata`
```bash
npm install reflect-metadata
```
## :rocket: Usage
### Javascript
In order to use decorators in javascript, a transpiler that can
```bash
npm i -D babel-cli
```
### TypeScript
You need to enable `experimentalDecorators` and `emitDecoratorMetadata` in your `tsconfig.json`
```json5
// file: tsconfig.json
{
compilerOptions: {
experimentalDecorators: true,
emitDecoratorMetadata: true,
},
}
```
in your index you have to import `reflect-metadata`
```typescript
import 'reflect-metadata'
```
and you are ready to go!
## :chart_with_upwards_trend: Examples
```typescript
import 'reflect-metadata'
import { use, schema, prop, ref, enums } from 'class-schema'
const vowels = ['a', 'e', 'i', 'o', 'u', 'y']
type Vowels = typeof vowels[number]
@schema()
class MyObject {
@enums(vowels)
myEnum: Vowels
}
@schema()
class MySchema {
@prop()
myProp: number
@array()
@prop(Number)
myPropArray: number[]
@ref(MyObject)
myObject: MyObject
}
```
> to get javascript object that represent jsonschema of class `use(MySchema)`
```json5
// output of `JSON.stringify(use(MySchema))
{
type: 'object',
properties: {
myProp: {
type: 'number',
},
myPropArray: {
type: 'array',
items: {
type: 'number',
},
},
myObject: {
type: 'object',
properties: {
myEnum: {
type: 'array',
items: {
type: 'string',
enum: ['a', 'e', 'i', 'o', 'u', 'y'],
},
},
},
required: ['myEnum'],
},
},
required: ['myProp', 'myPropArray', 'myObject'],
}
```
## :toolbox: Summary
### :arrow_forward: use
## :books: Documentation
[Full Documentation](https://giovannicardam.one/class-schema)
## :label: License
[MIT](https://github.com/GiovanniCardamone/class-schema/blob/main/LICENSE)