json_schema_to_freezed 1.0.1

Convert JSON schema files to Dart classes with Freezed or regular Dart classes with JSON serialization support.

JSON Schema to Freezed

A Dart tool that converts JSON schema files to Dart classes with Freezed or regular Dart classes with JSON serialization support.

Features

• Generate Freezed classes from JSON schema files
• Generate regular Dart classes with json_serializable support
• Support for field descriptions and nullable types
• Option to generate separate files for each model
• Watch mode for automatic regeneration when source files change
• Fetch JSON schema from local files or APIs
• Customizable output format and location

Installation

# Install globally to use the CLI
dart pub global activate json_schema_to_freezed

# Or add as a dev dependency in your project
dart pub add json_schema_to_freezed --dev

Usage

Command Line

You can use JSON Schema to Freezed with either local schema files or fetch schemas from an API.

Using a Local JSON Schema File

# Generate Freezed classes from a local JSON schema file
json_schema_to_freezed -f schema.json -o lib/models/generated.dart

# Generate regular Dart classes
json_schema_to_freezed -f schema.json -o lib/models/generated.dart --no-freezed

# Generate separate files for each model
json_schema_to_freezed -f schema.json -o lib/models/*.dart --separate-files

# Watch for changes in the source file
json_schema_to_freezed -f schema.json -o lib/models/generated.dart -w

Fetching JSON Schema from an API

# Generate Freezed classes from a JSON schema API endpoint
json_schema_to_freezed --url https://example.com/api/json-schema?moduleType=contact --output lib/models/generated.dart

# With authentication headers
json_schema_to_freezed --url https://example.com/api/json-schema?moduleType=contact --header "token:123" --output lib/models/gen.dart --separate-files

# Multiple headers can be passed
json_schema_to_freezed --url https://example.com/api/json-schema --header "token:123" --header "Content-Type:application/json" --output lib/models/gen.dart

Command Line Options

-f, --file          Path to the JSON schema file
    --url           URL to fetch JSON schema from an API
-H, --header        HTTP headers for API requests (format: "key:value")
-o, --output        Path to the generated Dart file or directory pattern
-s, --separate-files  Generate separate files for each model
-w, --watch         Watch for changes in the source file (file mode only)
-h, --help          Show this help menu
-c, --config        Path to a custom configuration file
    --[no-]freezed  Generate Freezed classes (default) or regular Dart classes
    --[no-]json-serializable  Add json_serializable support for JSON serialization

Example

Input JSON Schema

JSON schemas can contain multiple model definitions. Here's an example of a JSON schema with multiple models:

{
    "CreateContactParams": {
        "schema": {
            "type": "object",
            "properties": {
                "title": {
                    "type": "string"
                },
                "phone": {
                    "type": "string"
                }
            },
            "additionalProperties": false,
            "propertyOrder": [
                "title",
                "phone"
            ],
            "required": [
                "phone",
                "title"
            ],
            "$schema": "http://json-schema.org/draft-07/schema#"
        },
        "description": ""
    },
    "ShowContactByIdParams": {
        "schema": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                }
            },
            "additionalProperties": false,
            "propertyOrder": [
                "id"
            ],
            "required": [
                "id"
            ],
            "$schema": "http://json-schema.org/draft-07/schema#"
        },
        "description": ""
    },
    "UpdateContactParams": {
        "schema": {
            "additionalProperties": false,
            "type": "object",
            "properties": {
                "title": {
                    "type": "string"
                },
                "phone": {
                    "type": "string"
                },
                "id": {
                    "type": "string"
                }
            },
            "required": [
                "id"
            ],
            "$schema": "http://json-schema.org/draft-07/schema#"
        },
        "description": ""
    },
    "DeleteContactParams": {
        "schema": {
            "type": "object",
            "properties": {
                "id": {
                    "type": "string"
                }
            },
            "additionalProperties": false,
            "propertyOrder": [
                "id"
            ],
            "required": [
                "id"
            ],
            "$schema": "http://json-schema.org/draft-07/schema#"
        },
        "description": ""
    }
}

Generated Freezed Classes

When using the --separate-files option, the tool will generate separate files for each model. For example:

// create_contact_params.dart
// GENERATED CODE - DO NOT MODIFY MANUALLY

import 'package:freezed_annotation/freezed_annotation.dart';
import 'package:json_annotation/json_annotation.dart';

part 'create_contact_params.freezed.dart';
part 'create_contact_params.g.dart';

@freezed
class CreateContactParams with _$CreateContactParams {
  const factory CreateContactParams({
    required String title,
    required String phone,
  }) = _CreateContactParams;

  factory CreateContactParams.fromJson(Map<String, dynamic> json) =>
      _$CreateContactParamsFromJson(json);
}

Additional Notes

After generating the Freezed classes, you'll need to run the Freezed and JSON serializable code generators:

dart run build_runner build --delete-conflicting-outputs

License

This project is licensed under the MIT License - see the LICENSE file for details.