Zepgram JsonSchema
A Magento implementation for validating JSON Structures against a given Schema with support for Schemas of Draft-3 or Draft-4.
Based on https://github.com/justinrainbow/json-schema json schema.
For more information about json schema: http://json-schema.org/
Installation
composer require zepgram/module-json-schema
bin/magento module:enable Zepgram_JsonSchema
bin/magento setup:upgrade
Guideline
- Add the formatted json-schema in your module, where webservice will be implemented under
/etc/schemadirectory. - Create a Virtual Class of type
Zepgram\JsonSchema\Model\Validatorand adaptfileNameandmoduleNameparameters.
Example
/etc/di.xml
<virtualType name="HelloWorldValidator" type="Zepgram\JsonSchema\Model\Validator">
<arguments>
<argument name="fileName" xsi:type="string">schema/hello-world-service.jsonargument>
<argument name="moduleName" xsi:type="string">Zepgram_HelloWorldargument>
arguments>
virtualType>
/etc/schema/hello-world-service.json
{
"type":"array",
"items":{
"type":"object",
"required":[
"helloId",
"helloContact"
],
"properties":{
"helloId":{
"type":"string",
"description":"Hello Id"
},
"helloContact":{
"type":"array",
"items":{
"type":"object",
"required":[
"age",
"fullName"
],
"properties":{
"age":{
"type":"integer",
"format":"int32",
"description":"contact age",
"minimum":-2147483648,
"maximum":2147483647
},
"fullName":{
"type":"object",
"required":[
"firstname",
"lastname"
],
"properties":{
"firstname":{
"type":"string",
"description":"contact firstname"
},
"lastname":{
"type":"string",
"description":"contact lastname"
}
}
}
}
}
}
}
},
"$schema":"http://json-schema.org/draft-04/schema#"
}
Open API V3
If your architecture is using open API-V3 to describe web service usage you can convert it to json schema.
- Install the node utility: https://github.com/mikunn/openapi2schema
- Convert the open api yaml file into JSON:
openapi2schema -i my-custom-service.yaml | python -m json.tool | jq '."%end_point%".post.body' > my-custom-service.json
where%endpoint%must be replaced by your api endpoint described in yaml file (e.g.: /v1/customEndPoint)
Issues
If you encountered an issue during installation or with usage, please report it on this github repository.
245 Dec 15, 2022
26 Nov 21, 2022
99 Nov 11, 2022
2 Sep 9, 2022
64 Dec 31, 2022
2 Dec 30, 2022
389 Nov 24, 2022
625 Jan 3, 2023
2 Aug 22, 2022
2 Jul 31, 2022
370 Dec 29, 2022
13 Dec 28, 2022
2 Nov 9, 2022
73 Apr 1, 2022
4 Feb 22, 2022
69 Dec 18, 2022
1.4k Dec 26, 2022
220 Dec 29, 2022
2 Jun 29, 2022