Spectra #

Transform your Dart data classes into JSON Schema, OpenAPI, and Protocol Buffers specifications with a single annotation.

@Spectra()
@freezed
class User with _$User {
  const factory User({
    @Field(format: StringFormat.email) required String email,
    @Field(minimum: 0, maximum: 150) int? age,
  }) = _User;
}

Features #

Installation #

dart pub add spectra_schema
dart pub add dev:build_runner

Quick Start #

1. Annotate your class #

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:spectra_schema/spectra.dart';

part 'user.freezed.dart';
part 'user.g.dart';

@freezed
@Spectra(title: 'User')
class User with _$User {
  const factory User({
    @Field(minLength: 1, maxLength: 100) required String name,
    @Field(format: StringFormat.email) required String email,
    @Field(minimum: 0) int? age,
  }) = _User;

  factory User.fromJson(Map<String, dynamic> json) => _$UserFromJson(json);

  @spectraOutput
  static String get jsonSchema => _$UserJsonSchema;
}

2. Configure build.yaml #

targets:
  $default:
    builders:
      json_serializable:
        options:
          explicit_to_json: true

global_options:
  freezed|freezed:
    runs_before:
      - spectra_schema|spectra_schema

3. Generate #

dart run build_runner build

4. Use #

print(User.jsonSchema);
// {
//   "$schema": "https://json-schema.org/draft/2020-12/schema",
//   "title": "User",
//   "type": "object",
//   "properties": {
//     "name": { "type": "string", "minLength": 1, "maxLength": 100 },
//     "email": { "type": "string", "format": "email" },
//     "age": { "type": ["integer", "null"], "minimum": 0 }
//   },
//   "required": ["name", "email"]
// }

Annotations #

@Spectra #

@Spectra(
  title: 'User',
  description: 'A user object',
  formats: {SpectraFormat.jsonSchema, SpectraFormat.openApi},
  additionalProperties: false,
)

@Field #

// String
@Field(minLength: 1, maxLength: 100, pattern: r'^\w+$', format: StringFormat.email)

// Number
@Field(minimum: 0, maximum: 100, exclusiveMinimum: true, multipleOf: 0.5)

// Array
@Field(minItems: 1, maxItems: 10, uniqueItems: true)

// Meta
@Field(description: 'User email', deprecated: true, examples: ['a@b.com'])

@Ignore #

@Ignore()
String internalField;

Union Types #

@freezed
@Spectra()
sealed class Result with _$Result {
  const factory Result.success({required String data}) = Success;
  const factory Result.error({required String message}) = Error;
}

Generates oneOf with discriminator:

{
  "oneOf": [
    { "$ref": "#/$defs/Success" },
    { "$ref": "#/$defs/Error" }
  ],
  "discriminator": { "propertyName": "runtimeType" }
}

Output Formats #

JSON Schema (Draft 2020-12) #

@Spectra(formats: {SpectraFormat.jsonSchema})

OpenAPI 3.0/3.1 #

@Spectra(formats: {SpectraFormat.openApi})

Protocol Buffers #

@Spectra(formats: {SpectraFormat.protobuf})

syntax = "proto3";

message User {
  string name = 1;
  string email = 2;
  optional int64 age = 3;
}

String Formats #

Migration from SotiSchema #

- import 'package:soti_schema/soti_schema.dart';
+ import 'package:spectra_schema/spectra.dart';

- @SotiSchema()
+ @Spectra()

- @jsonSchema
+ @spectraOutput

# build.yaml
- soti_schema|openApiBuilder
+ spectra_schema|spectra_schema

License #

MIT