https://github.com/zepgram/module-json-schema
A Magento implementation for validating JSON Structures against a given Schema
https://github.com/zepgram/module-json-schema
Last synced: 6 months ago
JSON representation
A Magento implementation for validating JSON Structures against a given Schema
- Host: GitHub
- URL: https://github.com/zepgram/module-json-schema
- Owner: zepgram
- License: mit
- Created: 2021-11-04T22:58:59.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-04-01T21:59:46.000Z (about 4 years ago)
- Last Synced: 2025-02-25T16:40:53.560Z (over 1 year ago)
- Language: PHP
- Size: 5.86 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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
1. Add the formatted json-schema in your module, where webservice will be implemented under `/etc/schema` directory.
2. Create a Virtual Class of type `Zepgram\JsonSchema\Model\Validator` and adapt `fileName` and `moduleName` parameters.
## Example
**/etc/di.xml**
```xml
schema/hello-world-service.json
Zepgram_HelloWorld
```
**/etc/schema/hello-world-service.json**
```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.
1. Install the node utility: https://github.com/mikunn/openapi2schema
2. 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.