json-schema4

Zerotoprod\JsonSchema4

Contents

• Introduction
• Requirements
• Installation
• Documentation Publishing
  • Automatic Documentation Publishing
• Usage
• Publishing DataModels
• Local Development
• Contributing

Introduction

A DataModel for the Json Schema Draft 4 Specification.

Requirements

• PHP 8.1 or higher.

Installation

Install Zerotoprod\JsonSchema4 via Composer:

composer require zero-to-prod/json-schema4

This will add the package to your project’s dependencies and create an autoloader entry for it.

Documentation Publishing

You can publish this README to your local documentation directory.

This can be useful for providing documentation for AI agents.

This can be done using the included script:

# Publish to default location (./docs/zero-to-prod/json-schema4)
vendor/bin/zero-to-prod-json-schema4

# Publish to custom directory
vendor/bin/zero-to-prod-json-schema4 /path/to/your/docs

Automatic Documentation Publishing

You can automatically publish documentation by adding the following to your composer.json:

{
    "scripts": {
        "post-install-cmd": [
            "zero-to-prod-json-schema4"
        ],
        "post-update-cmd": [
            "zero-to-prod-json-schema4"
        ]
    }
}

Usage

use Zerotoprod\JsonSchema4\JsonSchema4;

$JsonSchema4 = JsonSchema4::from(json_decode($json, true));

$JsonSchema4->schema;

Publishing DataModels

You can directly import these files into your project like this:

./vendor/bin/json-schema4 app/JsonSchema4

The first argument is the destination of where the files are copied to.

Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page if you want to contribute.

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Commit changes (git commit -m 'Add some feature').
4. Push to the branch (git push origin feature-branch).
5. Create a new Pull Request.

This site is open source. Improve this page.