Skip to content

JSON schemas of the responses|requests for the battleship-game-api

Notifications You must be signed in to change notification settings

eugene-matvejev/schema-battleship

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

master
stub validation
< Circle CI > build

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

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