fezfez / php-json-schema-generator

该包已被弃用,不再维护。作者建议使用fezfez/php-json-schema-generator包。

一个用PHP编写的JSON Schema生成器。实现基于当前互联网草案。

1.0.0 2014-09-30 07:46 UTC

This package is auto-updated.

Last update: 2021-09-22 13:54:17 UTC


README

======================

Build Status HHVM Status Code Coverage Scrutinizer Code Quality Project Status

包:php-json-schema-generator

PHP JSON Schema生成器

关于JSON Schema

JSON已成为庞大的HTTP工具箱中的主流。为了使JSON更加稳定并延长数据结构的寿命,必须制定一些标准。这些标准将有助于定义结构,使行业可以依赖。在构建表示数据及其数据元素含义的方案中,可以找到一种统一的方式来解析数据和解释数据元素的含义。

由于JSON的灵活性,良好的Schema定义缓慢出现。目前有一个互联网草案正在制定。
(http://tools.ietf.org/html/draft-zyp-json-schema-04)

关于方案可以为您做什么以及不能做什么的相关用途/优点/缺点和其他讨论超出了本文档的范围。寻求您的创造力以了解可能的情况。

关于此工具

每次创建新的REST点或数据对象时,都需要手动编写JSON Schema,这有点麻烦。由于JSON可以用来表示各种数据对象,因此使用一种动态方式将一个对象映射到JSON Schema中可能会有所帮助。在这里,出于沟通的便利,将PHP数组视为对象。

该工具的目的是提供一个简单的方法来生成各种对象的JSON Schema。某些对象提供了更多选项来生成丰富的Schema,而某些对象则没有。JSON本身在元数据方面非常轻,因此需要根据对象的结构推断某些含义。

支持的解析对象

  • JSON字符串

安装

简单,假设您使用composer。将以下行添加到您的composer.json中,然后运行composer update。

"require": {
    "solvire/php-json-schema-generator": "dev-master"
}

测试

PHPUnit应包含在composer require-dev配置中。安装将直接在vendor/bin中放置一个可执行文件,因此可以从那里运行。

运行

$ vendor/bin/phpunit