jdesrosiers/silex-json-schema-provider

A Silex service provider for working with JSON Schema

v1.0.1 2018-04-24 02:25 UTC

This package is auto-updated.

Last update: 2022-06-25 22:29:19 UTC


README

Build Status Scrutinizer Code Quality Code Coverage

silex-json-schema-provider is a Silex service provider for working with JSON Schema.

Installation

Install the silex-json-schema-provider using composer. This project uses sematic versioning.

composer require jdesrosiers/silex-json-schema-provider "~1.0"

Parameters

  • json-schema.correlationMechanism: ("profile" or "link") Defaults to "link".
  • json-schema.describedBy: (string) A URI identifying the location of a schema that describes the response.

Services

Registering

$app->register(new JDesrosiers\Silex\Provider\JsonSchemaServiceProvider());

JSON Validation

JSON Schema validation is supported by https://github.com/geraintluff/jsv4-php.

$schemaJson = <<<SCHEMA
{
    "$schema": "http://json-schema.org/draft-04/hyper-schema#",
    "type": "object",
    "properties": {
        "id": {
            "type": "string"
        }
    }
}
SCHEMA;
$app["json-schema.schema-store"]->add("/schema/foo", json_decode($schemaJson));
$schema = $app["json-schema.schema-store"]->get("/schema/foo");
$validation = $app["json-schema.validator"]->validate($data, $schema);

Correlation

The JSON Schema specification has two recommendations for correlating a schema to a resource. This service provider registers after middleware that supports both. See http://json-schema.org/latest/json-schema-core.html#anchor33 for more information on schema correlation. Set the $app["json-schema.describedBy"] parameter to the schema that the response should be correlated to.

$app->get("/foo/{id}", function ($id) use ($app) {
    $app["json-schema.describedBy"] = "/schema/foo";
    return JsonResponse::create(array("id" => $id));
});

Full Example

$app["json-schema.schema-store"]->add("/schema/foo", $app["schemaRepository"]->fetch("foo"));

$app->put("/foo/{id}", function (Request $request, $id) use ($app) {
    $data = json_decode($request->getContent());

    $schema = $app["json-schema.schema-store"]->get("/schema/foo");
    $validation = $app["json-schema.validator"]->validate($data, $schema);
    if (!$validation->valid) {
        $error = array("validationErrors" => $validation->errors);
        return JsonResponse::create($error, Response::HTTP_BAD_REQUEST);
    }

    $isCreated = !$app["fooRepository"]->contains($id);
    $app["fooRepository"]->save($id, $data);

    $app["json-schema.describedBy"] = "/schema/foo";
    return JsonResponse::create($data, $isCreated ? Response::HTTP_CREATED : Response::HTTP_OK);
});