Как правильно проверить массив объектов с помощью JustinRainbow/JsonSchema

Edit-2: 22 мая

Я копал дальше, оказалось, что проблема связана с вашим преобразованием верхнего уровня в object

$jsonValidator->check($endpointData, (object)$schemaForPath);

Вы не должны были просто делать это, и все бы работало

$jsonValidator->check($endpointData, $schemaForPath);

Так что это не похоже на ошибку, это было просто неправильное использование. Если вы просто удалите (object) и запустите код

$ php test.php
End points does not validate. Violations:

[[0].title] The property title is required

[[1].title] The property title is required

Data: [
    {
        "id": 19874
    },
    {
        "id": 19873
    }
]
End points does not validate. Violations:

[title] The property title is required

Data: {
    "id": 19874
}

Редактировать-1

Чтобы исправить исходный код, вам нужно обновить CollectionConstraints.php

/**
 * Validates the items
 *
 * @param array            $value
 * @param \stdClass        $schema
 * @param JsonPointer|null $path
 * @param string           $i
 */
protected function validateItems(&$value, $schema = null, JsonPointer $path = null, $i = null)
{
    if (is_array($schema->items) && array_key_exists('$ref', $schema->items)) {
        $schema->items = $this->factory->getSchemaStorage()->resolveRefSchema((object)$schema->items);
        var_dump($schema->items);
    };

    if (is_object($schema->items)) {

Это точно справится с вашим вариантом использования, но если вы не предпочитаете изменять код из зависимости, используйте мой оригинальный ответ

Исходный ответ

В библиотеке есть ошибка/ограничение, заключающееся в том, что в src/JsonSchema/Constraints/CollectionConstraint.php они не разрешают переменную $ref как таковую. Если я обновил ваш код, как показано ниже

// Alias the schema for the endpoint, so JsonSchema can work with it.
$schemaForPath = aliasSchema($id, $schemaForPath);

if (array_key_exists('items', $schemaForPath))
{
  $schemaForPath['items'] = $factory->getSchemaStorage()->resolveRefSchema((object)$schemaForPath['items']);
}
// Validate the things
$jsonValidator->check($endpointData, (object)$schemaForPath);

и запустить его снова, я получаю необходимые исключения

$ php test2.php
End points does not validate. Violations:

[[0].title] The property title is required

[[1].title] The property title is required

Data: [
    {
        "id": 19874
    },
    {
        "id": 19873
    }
]
End points does not validate. Violations:

[title] The property title is required

Data: {
    "id": 19874
}

Вам нужно либо исправить CollectionConstraint.php, либо обратиться к разработчику репозитория. Или вручную замените свой $ref во всей схеме, как показано выше. Мой код решит проблему, специфичную для вашей схемы, но исправление любой другой схемы не должно быть большой проблемой.

EDIT: Здесь важно то, что предоставленный документ схемы является экземпляром схемы Swagger, в которой используется расширенное подмножество схемы JSON для определения некоторых случаев запроса и ответа. Саму схему Swagger 2.0 можно проверить по ее схеме JSON, но она не может действовать как JSON. Схема для структуры ответа API напрямую.

В случае, если схема объекта совместима со стандартной схемой JSON, вы можете выполнить проверку с помощью валидатора общего назначения, но вы должны предоставить все соответствующие определения, это может быть легко, когда у вас есть абсолютные ссылки, но сложнее для локальных (относительных) ссылок, которые начинаются с #/. IIRC они должны быть определены в локальной схеме.

Проблема здесь в том, что вы пытаетесь использовать ссылки на схемы, отделенные от области разрешения. Я добавил id, чтобы сделать ссылки абсолютными, поэтому не требуется попадание в область видимости.

"$ref": "http://example.com/my-schema#/definitions/Article"

Код ниже работает хорошо.

<?php

require_once __DIR__ . '/vendor/autoload.php';

$swaggerSchemaData = json_decode(<<<'JSON'
{
  "id": "http://example.com/my-schema",
  "swagger": "2.0",
  "info": {
    "termsOfService": "http://swagger.io/terms/",
    "version": "1.0.0",
    "title": "Example api"
  },
  "paths": {
    "/articles": {
      "get": {
        "tags": [
          "article"
        ],
        "summary": "Find all articles",
        "description": "Returns a list of articles",
        "operationId": "getArticleById",
        "produces": [
          "application/json"
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "type": "array",
              "items": {
                "$ref": "http://example.com/my-schema#/definitions/Article"
              }
            }
          }
        },
        "parameters": [
        ]
      }
    },
    "/articles/{articleId}": {
      "get": {
        "tags": [
          "article"
        ],
        "summary": "Find article by ID",
        "description": "Returns a single article",
        "operationId": "getArticleById",
        "produces": [
          "application/json"
        ],
        "parameters": [
          {
            "name": "articleId",
            "in": "path",
            "description": "ID of article to return",
            "required": true,
            "type": "integer",
            "format": "int64"
          }
        ],
        "responses": {
          "200": {
            "description": "successful operation",
            "schema": {
              "$ref": "http://example.com/my-schema#/definitions/Article"
            }
          }
        }
      }
    }
  },
  "definitions": {
    "Article": {
      "type": "object",
      "required": [
        "id",
        "title"
      ],
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64"
        },
        "title": {
          "type": "string",
          "description": "The title for the link of the article"
        }
      }
    }
  },
  "schemes": [
    "http"
  ],
  "host": "example.com",
  "basePath": "/",
  "tags": [],
  "securityDefinitions": {
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ]
}
JSON
);



$schemaStorage = new \JsonSchema\SchemaStorage();
$schemaStorage->addSchema('http://example.com/my-schema', $swaggerSchemaData);
$factory = new \JsonSchema\Constraints\Factory($schemaStorage);
$validator = new \JsonSchema\Validator($factory);

$schemaData = $swaggerSchemaData->paths->{"/articles"}->get->responses->{"200"}->schema;

$data = json_decode('[{"id":1},{"id":2,"title":"Title2"}]');
$validator->validate($data, $schemaData);
var_dump($validator->isValid()); // bool(false)
$data = json_decode('[{"id":1,"title":"Title1"},{"id":2,"title":"Title2"}]');
$validator->validate($data, $schemaData);
var_dump($validator->isValid()); // bool(true)

Я не уверен, что полностью понимаю ваш код здесь, но у меня есть идея, основанная на некоторых предположениях.

Предполагая, что $typeForEndPoint — это схема, которую вы используете для проверки, ваше ключевое слово item должно быть объектом, а не массивом.

Ключевое слово items может быть массивом или объектом. Если это объект, эта схема применима к каждому элементу в массиве. Если это массив, каждый элемент в этом массиве применим к элементу в той же позиции, что и проверяемый массив.

Это означает, что вы проверяете только первый элемент в массиве.

Если «элементы» являются схемой, проверка завершается успешно, если все элементы в массиве успешно проверяются на соответствие этой схеме.

Если "items" представляет собой массив схем, проверка завершается успешно, если каждый элемент экземпляра проверяется на соответствие схеме в той же позиции, если таковая имеется.

https://tools.ietf.org/html/draft-handrews-json-schema-validation-01#section-6.4.1

jsonValidator не любит смешанные ассоциации объектов и массивов, вы можете использовать либо:

$jsonValidator->check($endpointData, $schemaForPath);

or

$jsonValidator->check($endpointData, json_decode(json_encode($schemaForPath)));