| master | |
|---|---|
| stub validation | |
| < Circle CI > |  |
Battleship Game API responses/requests JSON schemas
the purpose of this repository is to store JSON schemas for the API responses|requests of the battleship-game-api as well as some stubs which represets business logic as schema can't always represent business logic
so whenever you're testing front-end or back-end you can relay on schemas and stub - instead of using real back-end for request/receive data
every JSON file is stored in 'PRETTY' format
stubs are validated against schemas on every Pull Request | Commit
THIS IS SPARE TIME PROJECT, WORK IN PROGRESS! HIGHLY EXPERIMENTAL!!!
used technologies
- node.js
- jest
- npm
- yarn
- composer
- json
- json schema
how to install
- php, composer composer provides opportunity to checkout additional sources of the packages add another source into your composer.json:
repositories": [
{ "type": "vcs", "url": "https://github.com/eugene-matvejev/battleship-game-api-json-schema" }
],
$ composer install eugene-matvejev/battleship-game-api-json-schema consider use --dev flag to add in devDependencies section
- node.js, npm|yarn WIP
how to run tests
$ npm test