Update @JsonSchema

[koriym]

• scheme json file location by CoC is deprecated.
• specify json_schema and json_validate folder in JsonSchemalModule
• @jsonschema::$schema prop to locate schema file
• @jsonschema::$params to locate request validation schema json file
• @jsonschema::$key for body array key

Install module

$this->install(new JsonSchemalModule($appDir . '/var/json_schema', $appDir . '/var/json_validate'));

Put scheme files under specified directories.

/var/json_schema/todo.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "Todo schema",
  "description": "Todo schema that should be used to model todo application.",
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "status": {
      "enum": ["1", "2"]
    },
    "created": {
      "type": "string",
      "format": "datetime"
    },
    "updated": {
      "type": "string",
      "format": "datetime"
    }
  },
  "required": ["title", "status", "created", "updated"],
  "additionalProperties": true
}

/var/json_validate/todo.post.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "/todo POST request validation",
  "properties": {
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    }
}

Annotate @JsonScheme for input parameters or (and) response validation.

response validation

    /**
     * @JsonSchema(key="todo", schema="todo.json")
     */
    public function onGet(string $id) : ResourceObject

request validation

    /**
     * @JsonSchema(params="todo.post.json")
     */
    public function onPost(string $title) : ResourceObject

key is optional when body contains certain key. ($this->body[$key] = [...];)
Properties (key, schema and request) can be combined in one @jsonschema annotation.

Older API still valid with new PR. Backward compatible.

• plus 100% test coverage
• include Change $request prop name to $params #113