https://github.com/dzakh/rescript-json-schema
📄 Typesafe JSON schema for ReScript
https://github.com/dzakh/rescript-json-schema
ajv json json-schema openapi rescript swagger typesafe
Last synced: 5 months ago
JSON representation
📄 Typesafe JSON schema for ReScript
- Host: GitHub
- URL: https://github.com/dzakh/rescript-json-schema
- Owner: DZakh
- License: mit
- Created: 2022-02-25T20:08:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-08T08:04:09.000Z (6 months ago)
- Last Synced: 2024-11-17T17:46:18.489Z (5 months ago)
- Topics: ajv, json, json-schema, openapi, rescript, swagger, typesafe
- Language: ReScript
- Homepage: https://dzakh.github.io/rescript-json-schema/
- Size: 1.31 MB
- Stars: 28
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/DZakh/rescript-json-schema/actions/workflows/ci.yml)
[](https://codecov.io/gh/DZakh/rescript-json-schema)
[](https://www.npmjs.com/package/rescript-json-schema)
# ReScript JSON Schema 📄
Typesafe JSON Schema for ReScript
- Provides ReScript types to work with [JSON schema](https://json-schema.org/)
- Converts [**rescript-schema**](https://github.com/DZakh/rescript-schema) into JSON schemas
- Converts JSON schemas to [**rescript-schema**](https://github.com/DZakh/rescript-schema)
## Install
```sh
npm install rescript-json-schema rescript-schema
```
Then add `rescript-json-schema` and `rescript-schema` to `bs-dependencies` in your `rescript.json`:
```diff
{
...
+ "bs-dependencies": ["rescript-json-schema", "rescript-schema"]
+ "bsc-flags": ["-open RescriptSchema"],
}
```
## Create JSON schemas with type safety
One of the library's main features is the **rescript-schema**, which provides a way to describe the schema of a value. This schema contains meta information used for parsing, serializing, and generating JSON Schema. When working with the library, you will mostly interact with **rescript-schema** to define the schema of the values you are working with.
For example, if you have the following schema:
```rescript
type rating =
| @as("G") GeneralAudiences
| @as("PG") ParentalGuidanceSuggested
| @as("PG13") ParentalStronglyCautioned
| @as("R") Restricted
type film = {
id: float,
title: string,
tags: array,
rating: rating,
deprecatedAgeRestriction: option,
}
let filmSchema = S.object(s => {
id: s.field("Id", S.float),
title: s.field("Title", S.string),
tags: s.fieldOr("Tags", S.array(S.string), []),
rating: s.field(
"Rating",
S.union([
S.literal(GeneralAudiences),
S.literal(ParentalGuidanceSuggested),
S.literal(ParentalStronglyCautioned),
S.literal(Restricted),
]),
),
deprecatedAgeRestriction: s.field("Age", S.option(S.int)->S.deprecate("Use rating instead")),
})
```
You can use it to generate JSON Schema for the value it describes:
```rescript
JSONSchema.make(filmSchema)
```
```json
{
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"Id": { "type": "number" },
"Title": { "type": "string" },
"Tags": { "items": { "type": "string" }, "type": "array", "default": [] },
"Rating": {
"anyOf": [
{ "type": "string", "const": "G" },
{ "type": "string", "const": "PG" },
{ "type": "string", "const": "PG13" },
{ "type": "string", "const": "R" }
]
},
"Age": {
"type": "integer",
"deprecated": true,
"description": "Use rating instead"
}
},
"additionalProperties": true,
"required": ["Id", "Title", "Rating"]
}
```
## Create **rescript-schema** from JSON schema
### Online
[Just paste your JSON schemas here!](https://dzakh.github.io/rescript-json-schema/)