Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spider-gazelle/json-schema
Describe crystal-lang JSON serializable types with JSON Schema
https://github.com/spider-gazelle/json-schema
Last synced: 3 months ago
JSON representation
Describe crystal-lang JSON serializable types with JSON Schema
- Host: GitHub
- URL: https://github.com/spider-gazelle/json-schema
- Owner: spider-gazelle
- License: mit
- Created: 2022-08-23T02:55:18.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2023-04-26T23:58:04.000Z (over 1 year ago)
- Last Synced: 2024-06-21T18:12:08.504Z (5 months ago)
- Language: Crystal
- Size: 17.6 KB
- Stars: 12
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - json-schema - convert JSON serializable classes into a [JSON Schema](https://json-schema.org/) representation (Data Formats)
README
# JSON Schema [![CI](https://github.com/spider-gazelle/json-schema/actions/workflows/ci.yml/badge.svg)](https://github.com/spider-gazelle/json-schema/actions/workflows/ci.yml)
A crystal lang tool for converting JSON serialisable class definitions into the [JSON Schema](https://json-schema.org/) representation.
## Installation
```yaml
dependencies:
json-schema:
github: spider-gazelle/json-schema
```## Usage
basic type support
```crystal
require "json-schema"
String.json_schema #=> {type: "string"}
Int32.json_schema #=> {type: "integer", format: "Int32"}
Float32.json_schema #=> {type: "number", format: "Float32"}
Array(String | Int32).json_schema #=> { type: "array", items: { anyOf: [{type: "integer", format: "Int32"}, {type: "string"}] } }
# Works with enums
enum TestEnum
Option1
Option2
endTestEnum.json_schema #=> {type: "string", enum: ["option1", "option2"]}
```
json serialisable support is included too, with deeply nested objects etc.
```crystal
require "json-schema"
class MyType
include JSON::Serializablegetter string : String
getter symbol : Symbol?
getter time : Time
getter integer : Int32
getter union_type : String | Int64 | Bool
endMyType.json_schema
# outputs
{
type: "object",
properties: {
string: {type: "string"},
symbol: {type: "string"},
time: {type: "string", format: "date-time"},
integer: {type: "integer", format: "Int32"},
union_type: {anyOf: [{type: "boolean"}, {type: "integer", format: "Int64"}, {type: "string"}]}
},
required: ["string", "time", "integer", "union_type"]
}```
You can also customize schema output using the `@[JSON::Field]` annotation
```crystal
require "json-schema"
class MyType
include JSON::Serializable# The `EpochConverter` here means the JSON value will actually be an integer
# so to avoid the output being `type: "string", format: "date-time"` you can
# supply a type override and custom format string.
@[JSON::Field(converter: Time::EpochConverter, type: "integer", format: "Int64")]
getter time : Time# or if you just want to provide a custom format
@[JSON::Field(format: "email")]
getter email : String
end```
for anything too confusing it falls back to a generic `{ type: "object" }` however this should only happen in some cases where you've inherited generic objects. e.g. `class Me < Hash(String, Int32)` (although this case is handled correctly)